MaritzCX ReST APIs
Overview
Welcome to our API documentation. At MaritzCX, we know that it’s not enough for your users to be able to access CX data through our graphical user interface. Your systems need to speak directly to ours.
The MaritzCX ReST APIs let you do this by giving you programmatic access to key parts of the MaritzCX platform, including Survey Management, Case Management, and Data Import.
Notes: 1. To use the APIs, you must use the correct URL for your geographic location, detailed in the Getting Started sections of Survey Management, Case Management, and Data Import. Otherwise your calls will fail. 2. To use the MaritzCX API, you must have access to the MaritzCX platform. If you do not, contact your CX lead. You should also make sure to get an account for the MaritzCX Knowledge Center, which contains comprehensive detail on the tasks you will be performing within the MaritzCX platform. Again, contact your CX lead if you need to get an account.
Permissions
Any registered user can call the APIs. However, in order to use most of the methods under the Survey Management API, you will need login credentials that have one of the following permissions:
- Survey Owner – This is simply the user account either that created or currently owns the survey itself.
- Survey System Administrator – This permission is set for the user in the admin area of the MaritzCX platform.
- System Administrator – This permission is set for the user in the admin area of the MaritzCX platform.
Note: To make sure your API user has either Survey System Administrator or System Administrator privilege, see the Survey Ownership instructions under Retrieving Data.
To use the Case Management API, you just need to make sure the following is true:
- Case Management is enabled for the company.
- The logged-in user has access to some cases – the case worker view is all that is exposed (i.e. Case Admin functions are not exposed by the API).
To use the Data Import API, you must be one of the following:
- Survey Owner – This is simply the user account either that created or currently owns the survey itself.
- Survey Analyst
- Survey Manager
Survey Management API
Overview
The MaritzCX Survey Management API allows you to programmatically perform various aspects of survey administration, from creating email lists to sending invitations and reminders, prepopulating survey questions, inserting respondent data, managing opt-outs, and many other important tasks.
The response data-oriented methods within the Survey Management API return response list data in a JSON payload, allowing you to then consume that data in a variety of ways – such as pushing it into a database that is linked to your CRM or other third party application.
The following entity relationship diagram shows how the various objects within the API are related:

For first steps in using the API, see the topics Retrieving Data and Sending Batch Email Invitations.
Permissions
In order to use most of the methods under the Survey Management API, you will need login credentials that have one of the following permissions:
- Survey Owner – This is simply the user account either that created or currently owns the survey itself.
- Survey System Administrator – This permission is set for the user in the admin area of the MaritzCX platform.
- System Administrator – This permission is set for the user in the admin area of the MaritzCX platform.
Note: To make sure your API user has either Survey System Administrator or System Administrator privilege, see the Survey Ownership instructions under Retrieving Data.
Base URLs
To connect to the Survey Management API, use the following as your base URL:
North America – https://sampleapi.allegiancetech.com
Europe, the Middle-East, and Africa – https://sampleapi.mcxplatform.de
Australia – https://sampleapi.mcxplatform.com.au
Rate Limits
To keep the API performant for all consumers, the MaritzCX platform implements rate limiting. That means that in a given time period you will only be allowed to send a certain number of requests/pull a certain amount of data. We’ve kept these limits high enough to allow standard usage of the API while still low enough to prevent abuse of the service.
The following limits apply to endpoints within the Survey Management API:
- The endpoint getEmailListImportStatus enforces the following rate limit: you can call the endpoint up to once per minute.
- The endpoint getEmailListRecipientStatusListV2 enforces the following rate limit: you can call the endpoint up to once per minute.
- The endpoint getOptOuts implements an export limitation. The default limit is defined as 50,000 opt-outs per hour.
- The endpoint getResponsesBySurveyId implements an export limitation. The default limit is defined as 50,000 responses per hour, where one response means the set of answers a respondent has given to complete a survey (i.e. all the answers contained in one survey response).
- The endpoint getRespondentsBySurveyId also implements an export limitation. The default limit is defined as 50,000 respondents per hour.
- The endpoint getTextAnalyticsResponsesBySurveyId shares an export limitation with endpoint getResponsesBySurveyId. The default limit is defined as 50,000 responses per hour (regardless which of these methods is used), where one response means the set of answers a respondent has given to complete a survey (i.e. all the answers contained in one survey response).
- The endpoint newEmailListV2 enforces the following rate limit: you can call the endpoint up to once per minute.
- The endpoint sendInvitationForNewRecipients enforces the following rate limits: you can call the endpoint up to once per minute, and you can export up to 500 records per minute.
The following limits apply to endpoints within the Data Import API:
- 1 request per second
- 10,000 requests per day
If the rate limit is exceeded then you will receive an HTTP 429 response with following message in the body:
“Rate limit exceeded. Please try again later.”
Retrieving Data
MaritzCX customers can use the Survey Management API to pull data from the MaritzCX platform. This document describes sample API calls for common scenarios.
Assumptions
- The customer pulls the MaritzCX data into their data warehouse.
- The customer would like to future-proof the integration with MaritzCX. Data from new or changed surveys and questions should flow into the data warehouse without the need to make any changes to the integration itself.
- Data is loaded daily.
(for the example below)
- Current time is 29 July 2017, 02:00 AEST.
- Data is loaded between 02:00 and 03:00 AEST.
- Previous day: 28 July 2017 00:00 – 29 July 2017 00:00 AEST.
- Previous day in UTC time: 27 July 2017 14:00 – 28 July 2017 14:00.
Survey Ownership
Note: If you do not have access to the MaritzCX platform, contact your CX lead. You should also make sure to get an account for the MaritzCX Knowledge Center, which contains comprehensive detail on the tasks you will be performing within the MaritzCX platform. Again, contact your CX lead if you need to get an account.
1. Create a role for the API user. Log into the MaritzCX platform and select the gear icon to go to Platform Administration. From there, go to User Management | Application Access Roles. On this page, select Add New, then check the boxes Survey System Administrator and System Administrator:

In the field marked Role Name, enter “API User”, then scroll to the bottom of the screen and select Save Role.
2. Next, go to User Management | User Profiles and create a platform user (“apiuser@customer.com”) who will own all surveys which should be pushed into your data warehouse. Assign it the role “API User” that you just created.
The API will use this user to log into the platform API.
Data Model

API Request Overview
With the exception of GET ping, requests should be sent as an HTTP POST. Set the Accept header to “Accept: application/json”, and set the Content-type header to “Content-type: application/json”. The request parameters should be placed in the body of the HTTP request.
Here is a Curl example of a valid request:
curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"userName" : "apiuser@customer.com", "password" : "secret", "companyName" : "demo.aus.allegiancetech.com"}' https://sampleapi.aus.allegiancetech.com/EmailImport.HttpService.svc/web/authenticate
Retrieve Response Data
1. Call authenticate – Provide a valid username, password, and the company name for the user with the role “API User”.
[your region’s base URL here]/HttpService.svc/web/authenticate
{"userName": "apiuser@customer.com",
"password": "secret",
"companyName": "demo.aus.allegiancetech.com"
}
2. Retrieve all surveys owned by apiuser@customer.com. Note that this user will only see surveys owned by apiuser@customer.com. Any survey which should not be imported in the data warehouse should have a different owner.
[your region’s base URL here]/HttpService.svc/web/getSurveyList
{"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3"}
Store the result in a table called “mcx_surveys”.
3. Retrieve all questions from the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey (using surveyId):
[your region’s base URL here]/HttpService.svc/web/getQuestionsBySurveyId
{"token": "496d9aea-2436-4a15-8e46-09156851cf06",
"surveyId" : 6
}
Store the result in a table called “mcx_questions”. Note that the XML returned does not contain the surveyId. In general, you would store the surveyId from the HTTP request in the mcx_ questions table.
4. Retrieve all answers from the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey (using surveyId):
[your region’s base URL here]/HttpService.svc/web/getAnswersBySurveyId
{"token": "496d9aea-2436-4a15-8e46-09156851cf06",
"surveyId" : 6
}
Store the result in a table called “mcx_answers”. Note that the XML returned does not contain the surveyId. In general, you would store the surveyId from the HTTP request in the mcx_answers table.
5. Retrieve all respondents from the previous day to the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey (using surveyId and a filter on CompletedDate):
[your region’s base URL here]/HttpService.svc/web/getRespondentsBySurveyId
{"token": "d0ad4fef-2285-429c-813f-64336fd3ca86",
"surveyId" : 6,
"filterXml" : “
CompletedDate
Between
2017-07-27T14:00:00
2017-07-28T14:00:00
"
}
All queries are performed in the database time zone where the server is located. North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern. For getRespondentsBySurveyId to function correctly, you must convert your local time to UTC.
www.timeanddate.com is a useful tool to manage this. On it, select Time Zones | Time Zone Converter, input your local time zone, and select “Include UTC Time in Results”. You can then see the UTC time that will be needed.
You must also use the ISO 8601 date/time format for all filterXML date/time parameters.
Store the result in a table called “mcx_respondents”.
6. Retrieve all responses from the previous day to the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey. To do so, use surveyId and a filter on ModifiedDate (ModifiedDate ensures that the request picks up any responses manually updated after the response was submitted):
[your region’s base URL here]/HttpService.svc/web/getResponsesBySurveyId
{"token": "d0ad4fef-2285-429c-813f-64336fd3ca86",
"surveyId" : 6,
"filterXml" : “
ModifiedDate
Between
2017-07-27T14:00:00
2017-07-28T14:00:00
"
}
See the note under #5 regarding date/time format.
Store the result in a table called “mcx_responses”. Also note that the number of rows in this table can be significant.
Retrieve Email Invitation Data
7. Retrieve all email lists uploaded during the previous 7 days for the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey (using surveyId and a filter on UploadedOn for the past 7 days). Specifying the last 7 days ensures that the request will return any asynchronous bounces which we delivered well after sending the emails.
[your region’s base URL here]/HttpService.svc/web/getEmailListsBySurveyId
{"token": "d0ad4fef-2285-429c-813f-64336fd3ca86",
"surveyId" : 6,
"filterXml" : “
UploadedOn
Between
2017-07-27T14:00:00
2017-07-28T14:00:00
"
}
Store the result in a table called “mcx_email_lists”. See the note under #5 regarding date/time format.
8. Retrieve the recipient status of the email lists returned in step 7, then loop through the list of email lists returned by getEmailListsBySurveyId and call for each email list (using emailListId).
[your region’s base URL here]/HttpService.svc/web/getEmailListRecipientStatusListV2
{"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"emailListId" : 6152
}
Store the result in a table called “mcx_email_recipients”. Note that the JSON returned does not contain the emailListId. In general, you would store the emailListId from the HTTP request in the mcx_email_recipients table.
9. Retrieve the survey opt-outs from the previous day to the surveys returned in step 2, then loop through the list of surveys returned by getSurveyList and call for each survey (using surveyId and a filter on RequestedDate):
[your region’s base URL here]/HttpService.svc/web/getOptOuts
{"token": "d0ad4fef-2285-429c-813f-64336fd3ca86",
"surveyId" : 6,
"filterXml" : “
RequestedDate
Between
2017-07-27T14:00:00
2017-07-28T14:00:00
"
}
Store the result in a table called “mcx _optouts”. See the note under #5 regarding date/time format.
Optional – Limit Which Questions Should be Returned
You may wish to limit the questions being returned by getResponsesBySurveyId. You may for example not wish to retrieve all feedfile data. To achieve this, follow these steps:
Create a standard question tag for all of the questions you would like to store in your data warehouse. For example, the question tag of any question that should get loaded into the data warehouse can start with “DW_”.
[your region’s base URL here]/HttpService.svc/web/getQuestionsBySurveyId; with a filter defined as “QuestionShortCode Contains DWH_”
{"token": "8238a7f7-8423-41e4-937c-8c667ddb4ff9",
"surveyId" : 6,
"filterXml":"QuestionShortCodeContainsDWH"
}
Use the questionids returned by ../getQuestionsBySurveyId as a filter in ../getResponsesBySurveyId (filter on QuestionIds with a comma-separated list of integers, e.g. 143,144):
{"token": "ea2327cf-74c1-44cd-b308-0955e4adebd9",
"surveyId" : 6,
"filterXml" : "
CompletedDate
Between
2017-07-27T14:00:00
2017-07-28T14:00:00
QuestionIds
Equals
143,144
"
}
See the note under #5 regarding date/time format.
Sending Batch Email Invitations
MaritzCX has a number of ways to collect survey responses. One way is to invite people to take a survey via email. In order to send the emails, the MaritzCX platform requires a .CSV file to be supplied to the platform. This file is loaded into an email list, and then email invitations are sent to the email addresses in the email list.
When a .CSV file is loaded into an email list, its columns are “mapped” to questions in the survey, as described in this Knowledge Center article. These questions are referred to as “pre-pop” or pre-populated questions. These pre-pop questions can be used in the survey to either display information about the recipient in the survey, e.g. show their account type, or used in conditional logic to display a question relevant to the recipient, or used to hold operational data, e.g. agent name or agent team for filtering/grouping when reporting.
You can load the .CSV files and send invitations through the MaritzCX platform GUI either manually (as in the Knowledge Center article above), or using an automated upload (loading files from the MaritzCX SFTP), or using the MaritzCX API. Note that if the MaritzCX API is used to load an email list, invitations can only be scheduled and sent either manually through the MaritzCX platform GUI or via the MaritzCX API. The MaritzCX platform does not support using the GUI to configure automated scheduling of invitations sent to email list created via the API.
This document describes how to use the MaritzCX API to load an email list and send email invitations.
Survey Ownership
Note: If you do not have access to the MaritzCX platform, contact your CX lead. You should also make sure to get an account for the MaritzCX Knowledge Center, which contains comprehensive detail on the tasks you will be performing within the MaritzCX platform. Again, contact your CX lead if you need to get an account.
1. Create a role for the API user. Log into the MaritzCX platform and select the gear icon to go to Platform Administration. From there, go to User Management | Application Access Roles.

2. Next, go to User Management | User Profiles and create a platform user (“apiuser@customer.com”) who will own all surveys which should be pushed into your data warehouse. Assign it the role “API user”.
You should then always use this user to log into the API.
Prepare Email List File
When sending email lists via the MaritzCX GUI or loading an email list via SFTP, the user is required to supply a .CSV file containing the list of recipients with their email addresses, as well as other data that will be pre-populated into the survey questions, for example operational data such as account number, etc.
The minimum required is a column containing an email address. The MaritzCX API sends this same .CSV content via the API. You will need to prepare the content in a similar way.
Refer to the Sample Email List File for more details. For the purposes of this document, all sample requests will be made with the following email list:
Email,Question1,Question2
user@domain.com,A,B
Prepare Mapping File
Create a mapping file. This file will contain mapping information that tells the API how the columns in your email list file are related to system fields and pre-populated survey questions. The mapping file is also used to map each recipient to a Survey Language using the SystemFieldName=”Language”.
To produce the mapping file you will need:
- The survey code of your survey;
- The column names of the feed file;
- The corresponding question tags of your prep-pop questions;
- A de-duplicated email list file.
Refer to the Sample Mapping File for more details.
Note: To ignore duplicate invitees (dedupe) when importing the email list file, set the attribute DuplicateRule of element EmailListMappingDefinition to “0”.
For the purposes of this document all example requests will be made with the following mapping file:
<!--?xml version="1.0" encoding="utf-8" ?--> user@notifcationdomain.com
API Request Overview
With the exception of GET ping, requests should be sent as an HTTP POST. Set the Accept header to “Accept: application/json”, and set the Content-type header to “Content-type: application/json”. The request parameters should be placed in the body of the HTTP request.
Here is a Curl example of a valid request:
curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"userName" : "apiuser@customer.com", "password" : "secret", "companyName" : "demo.aus.allegiancetech.com"}' https://sampleapi.aus.allegiancetech.com/EmailImport.HttpService.svc/web/authenticate
Sequence Diagram

Authenticate
Provide a valid username, password, and the company name for the user with the role “API user”. Store the token returned in the response for future API requests.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/authenticate \
--header 'content-type: application/json' \
--data '{
"userName": "apiuser@customer.com",
"password": "yourAPIUser",
"companyName": "yourCompanyName"
}'
Sample Response
{
"AuthenticateResult":"8544621e-ba51-4db8-bff4-2d5a1e2d9ea3"
}
Retrieve Survey Code and Survey Id
Call getSurveyList to retrieve all surveys owned by apiuser@customer.com. Note that this user will only see surveys owned by apiuser@customer.com.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/getSurveyList \
--header 'content-type: application/json' \
--data '{
"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3"}
}'
Sample Response
{
"GetSurveyListResult":[
{
"Active":true,
"CutOffDate":null,
"Description":"First Survey",
"InactiveDate":null,
"Source":1,
"SurveyCode":"4JANRX",
"SurveyId":1
}
]
}
SurveyCode is required in the Mapping File. SurveyId is required when scheduling invitations and reminders.
Refer to getSurveyList for more information.
Retrieve Invitation Template Ids
Call getSurveyInvitationTemplates to retrieve invitation template ids for the survey.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/getSurveyInvitationTemplates \
--header 'content-type: application/json' \
--data '{
"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"surveyId": 1
}'
Sample Response
{
"GetSurveyInvitationTemplatesResult": {
"InvitationTemplatesEmailList": [
{
"InvitationtemplateId": 8101,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "...",
"Subject": "Your feedback is vital to serving you better"
},
{
"InvitationtemplateId": 8120,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "...",
"Subject": "Template for doc"
}
],
"Surveyid": 1,
"TemplateType": 0
}
}
InvitationtemplateId is required when scheduling invitations.
Retrieve Reminder Template Ids
Call getSurveyReminderTemplates to retrieve reminder template ids for the survey.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/getSurveyReminderTemplates \
--header 'content-type: application/json' \
--data '{
"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"surveyId": 1
}'
Sample Response
{
"GetSurveyReminderTemplatesResult": {
"InvitationTemplatesEmailList": [
{
"InvitationtemplateId": 8121,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "...",
"Subject": "Test Reminder for Doc"
}
],
"Surveyid": 1,
"TemplateType": 1
}
}
InvitationtemplateId is required when scheduling reminders.
Note: Each template has 1 language. If you are using multiple languages, refer to getSurveyReminderTemplates.
Create Email List
You create an email list by calling the endpoint newEmailListV2.
The request body contains:
- The token
- The name of the email list to be created
- Email list file as an unsigned byte array
- Mapping File as an unsigned byte array
Note: Both Email List File and Mapping File must be converted to byte array. Each byte must be represented as an unsigned integer. The resulting array is added to the JSON request.
See the Sample Request under newEmailListV2 for an example request body that contains an encoded email list file and mapping file.
See Encoding Implementation Examples for sample encoding algorithms.
Call newEmailListV2.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/newEmailListV2 \
--header 'content-type: application/json' \
--data '{
"token":"8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"emailListFile":[239, 187, 191, ],
"mappingFile":[],
"emailListName":"My First Email List"
}'
Note that you must prepend a Byte Order Marker [239, 187, 191] to the emailListFile if you are sending non-ASCII UTF-8 characters.
Sample Response
{
"NewEmailListV2Result":{
"DataImportId":1206,
"ErrorMessage":""
}
}
Refer to newEmailListV2.
Schedule Email Invitations
Call insertInvitationSchedule
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/insertInvitationSchedule \
--header 'content-type: application/json' \
--data '{
"token":"8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"surveyId":"1",
"sampleIds":"1190",
"templateIds":"8101",
"startTime":"1/12/2019 8:55AM",
"startTimeCulture":"en-GB",
"startTimeZoneId":"AUS Eastern Standard Time"
}'
Notes:
- sampleIds use the EmailListId returned by getEmailListImportStatus.
- templateIds can be found by calling endpoint getSurveyInvitationTemplates. You can also find it in the platform URL when editing a template:

- startTime is in the format D/M/YYYY h:ma if you are using startTimeCulture:”en-GB”
- Ensure startTime is in the future. For example, assume your process runs at 9AM each day and schedules invites for 10AM the same day. If your processing is delayed until after 10AM, you may wish to either set startTime to “now” to send immediately or 10AM the next day.
- startTimeZoneId is a .Net timezone reference. For the list of Microsoft Time Zone Index Values, see this page.
If you are using multiple languages, specify a comma-separated list of template IDs, e.g. “templateIds”:”8101,8102,8103″.
The API will automatically map the value in the language field (specified in SystemFieldName=”Language”) to the language name of the email template (“LanguageName”).
Sample Response
{
"InsertInvitationScheduleResult":"OK"
}
Refer to insertInvitationSchedule for more information on the endpoint.
Schedule Reminder Emails (Optional)
If reminders are required call insertReminderSchedule.
curl -s --request POST --url https://sampleapi.mcxplatform.com.au/EmailImport.HttpService.svc/web/insertReminderSchedule \
--header 'content-type: application/json' \
--data '{
"token":"8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"surveyId":"1",
"sampleIds":"1190",
"templateIds":"8121",
"startTime":"1/12/2019 8:55AM",
"startTimeCulture":"en-GB",
"startTimeZoneId":"AUS Eastern Standard Time"
}'
Notes:
- sampleIds use the EmailListId returned by getEmailListImportStatus.
- templateIds can be found by calling the endpoint getSurveyInvitationTemplates. You can also find it in the platform URL when editing a template:

- startTime is in the format D/M/YYYY h:ma, which is an absolute time for the reminders to be sent. Typically in production reminders will be sent 5-7 days after the initial invitation is sent. To assist end-to-end testing of your survey program, it is recommended that you ensure it is easy to adjust when the when the reminders are sent, e.g. for UAT, schedule reminders 1 hour after invitations.
- startTimeZoneId is a .Net timezone reference. For the list of Microsoft Time Zone Index Values, see this page.
If you are using multiple languages, specify a comma-separated list of template IDs, e.g.
“templateIds”:”8121,8122,8123″,
The API will automatically map the value in the language field (specified in SystemFieldName=”Language”) to the language name of email template (“LanguageName”).
Sample Response
{
"InsertReminderScheduleResult":"OK"
}
FAQ
The answer depends on how quickly the customer would like to download the responses from our platform. The process outlined below assumes a daily download that occurs around 2AM (though a similar concept will work for hourly downloads):
1. Call authenticate.
2. Call getSurveyList. This returns a list of all surveys the authenticated user (used in authenticate) has access to.
3. Loop through the list returned by getSurveyList:
a. Get the latest questions – call getQuestionsBySurveyId (e.g. What is your gender?) –> the result is a reference table with questions.
b. Get the latest answers – call getAnswersBySurveyId (e.g. the set of answers to the question “What is your gender?”: male, female –> the result is a reference table with possible answers.
4. Call getResponsesBySurveyId with a filter on Completed date (retrieve yesterday’s responses).
- The unique key for the result is on ResponseId
- To avoid duplication, do an “upsert” in the target database using ResponseId as the unique key.
5. End loop.
This concludes the process of retrieving all responses for an ongoing open survey, without any duplication.
See above. getSurveyList will return all surveys from all users (depending on the access level of the user logged in using authenticate).
See above. Set a filter using the “Completed date”. To prevent any duplicates (a survey result could be manually updated), you “upsert” using the unique key set to ResponseId.
POST authenticate
Authenticates a client. authenticate must be called to retrieve a token, which is required by subsequent requests.
URL
Parameters
userName=[string] Required
Username of the user that will be authenticated.
password=[string] Required
Password of the user that will be authenticated.
companyName=[string] Required
A specific value within the MaritzCX platform that identifies the customer. To get this value, see this Knowledge Center article. The MaritzCX Knowledge Center contains comprehensive detail on the tasks you will be performing within the MaritzCX platform. Contact your CX lead if you do not have an account.
Sample Request
{
"userName":"johnque@email.com",
"password":"password",
"companyName":"generalindustries.allegiancetech.com"
}
Response Values
AuthenticateResult=[Guid]
A Guid authentication token required by subsequent service calls.
Sample Response
{
"AuthenticateResult":"c3f90919-5b36-4711-b796-782dbd75fe43"
}
Error Response
See the Error Responses section for the various error responses possible.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"userName": "randy.matlock%40example.com", \
"password": "Blabbus_99", \
"companyName": "generalindustries.allegiancetech.com" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/authenticate'
Notes
POST createInvitationTemplateBySurveyId
Templates are used to give a standard form to email invitations and reminders. createInvitationTemplateBySurveyId allows you to create your own invitation templates for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
The ID of the survey that the invitation belongs to. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
languageId=[int] Required
The languageId for the invitation. To get the language IDs available for the survey, first issue getLanguagesBySurveyId.
invitationTemplateName=[string] Required
The name or description of the template. Required if the source is “Bonfire”.
isDefault=[bool] Optional
Flag set if the template is the default template for the given survey. Valid only for surveys whose source is “Bonfire”. Will default to “false” if omitted.
invitationSubject=[string] Required
Subject for the invitation email.
fromName=[string] Required
Sender’s name for the invitation email.
fromEmail=[string] Required
Sender’s email for the invitation email.
invitationText=[string] Required
Content for the invitation email.
source=[string] Optional
Source of the reminder. Currently “Bonfire” and “Desktop” are accepted. Will default to “Bonfire” if the value passed in is anything other than “Desktop”.
Sample Request
{
"token": "691038b0-e2fe-456e-a849-1d3f92d9436d",
"surveyId":20,
"languageId":31,
"invitationTemplateName":"Test Template for doc.",
"isDefault":"true",
"invitationSubject":"Template for doc",
"fromName":"Test name",
"fromEmail":"test@maritzcx.com",
"invitationText":"
<!DOCTYPE html>
<html>
<body>
<h1>My First Template</h1>
<p>My first template.</p>
</body>
</html>",
"source":"Bonfire"
}
Response Values
CreateInvitationTemplateBySurveyIdResult=[string]
A string representation of the inserted object with the new templateId. Contains the following elements:
- TemplateId – The identifier of the template.
- SurveyId – The identifier of the survey.
- LanguageId – The identifier of the template language. For a readout of the survey’s languages, issue the call getLanguagesBySurveyId.
- Subject – The subject of the email template.
- FromName – The “From” name of the email template.
- FromEmail – The “From” email of the email template.
- ReplyEmail – The “Reply” email of the email template.
- Message – HTML body of the email message.
- Description – The description of the email template.
- IsDefault – A boolean value which indicates whether or not the template is the default one. Possible values are “True” and “False”.
- TemplateType – Indicates whether the template is for an Invitation or Reminder.
- Source – Source of the invitation. Possible values are “Bonfire” and “Desktop”.
Sample Response
{
TemplateId:72,
SurveyId:85,
LanguageId:19,
Subject:Test Invitation for Doc,
FromName:Test Name,
FromEmail:test@maritzcx.com,
ReplyEmail:test@maritzcx.com,
Message:
<!DOCTYPE html>
<html>
<body>
<h1>My First Invitation</h1>
<p>This is an invitation.</p>
</body>
</html>,
Description:Test Invitation for Doc,
IsDefault:False,
TemplateType:Invitation,
Source:Bonfire
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"surveyId":20, \
"languageId":31, \
"invitationTemplateName": "Test Template for doc.", \
"isDefault": "true", \
"invitationSubject": "Template for doc", \
"fromName": "Test name", \
"fromEmail": "test@maritzcx.com", \
"invitationText": "<!DOCTYPE html>
<html>
<body>
<h1>My First Template</h1>
<p>My first template.</p>
</body>
</html>", \
"source": "Bonfire" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/createInvitationTemplateBySurveyId'
Notes
POST createReminderTemplateBySurveyId
Templates are used to give a standard form to email invitations and reminders. createReminderTemplateBySurveyId allows you to create your own reminder templates for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
The ID of the survey that the reminder belongs to. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
languageId=[int] Required
The languageId for the reminder. To get the language IDs available for the survey, first issue getLanguagesBySurveyId.
reminderTemplateName=[string] Required
The name or description of the template. Required if the source is “Bonfire”.
isDefault=[bool] Optional
Flag set if the template is the default template for the given survey. Valid only for surveys whose source is “Bonfire”. Will default to “false” if omitted.
reminderSubject=[string] Required
Subject for the reminder email.
fromName=[string] Required
Sender’s name for the reminder email.
fromEmail=[string] Required
Sender’s email for the reminder email.
reminderText=[string] Required
Content for the reminder email.
source=[string] Optional
Source of the reminder. Currently “Bonfire” and “Desktop” are accepted. Will default to “Bonfire” if the value passed in is anything other than “Desktop”.
Sample Request
{
"token":"6591ba61-0386-4997-b2b8-ede834e4bc2b",
"surveyId":20,
"languageId":31,
"reminderTemplateName":"Test Reminder for Doc",
"isDefault":"true",
"reminderSubject":"Test Reminder for Doc",
"fromName":"Test Name",
"fromEmail":"test@maritzcx.com",
"reminderText":"
<!DOCTYPE html>
<html>
<body>
<h1>My First Reminder</h1>
<p>This is a reminder.</p>
</body>
</html>",
"source":"Bonfire"
}
Response Values
CreateReminderTemplateBySurveyIdResult=[string]
A string representation of the inserted object with the new templateId. Contains the following elements:
- TemplateId – The identifier of the template.
- SurveyId – The identifier of the survey.
- LanguageId – The identifier of the template language. For a readout of the survey’s languages, issue the call getLanguagesBySurveyId.
- Subject – The subject of the email template.
- FromName – The “From” name of the email template.
- FromEmail – The “From” email of the email template.
- ReplyEmail – The “Reply” email of the email template.
- Message – HTML body of the email message.
- Description – The description of the email template.
- IsDefault – A boolean value which indicates whether or not the template is the default one. Possible values are “True” and “False”.
- TemplateType – Indicates whether the template is for an Invitation or Reminder.
- Source – Source of the invitation. Possible values are “Bonfire” and “Desktop”.
Sample Response
{
TemplateId:86,
SurveyId:20,
LanguageId:31,
Subject:Test Reminder for Doc,
FromName:Test Name,
FromEmail:test@maritzcx.com,
ReplyEmail:test@maritzcx.com,
Message:
<!DOCTYPE html>
<html>
<body>
<h1>My First Reminder</h1>
<p>This is a reminder.</p>
</body>
</html>,
Description:Test Reminder for Doc,
IsDefault:False,
TemplateType:Reminder,
Source:Bonfire
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "6591ba61-0386-4997-b2b8-ede834e4bc2b", \
"surveyId":20, \
"languageId":31, \
"reminderTemplateName": "Test Reminder for Doc", \
"isDefault": "true", \
"reminderSubject": "Test Reminder for Doc", \
"fromName": "Test Name", \
"fromEmail": "test@maritzcx.com", \
"reminderText": "<!DOCTYPE html>
<html>
<body>
<h1>My First Reminder</h1>
<p>This is a reminder.</p>
</body>
</html>", \
"source": "Bonfire" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/createReminderTemplateBySurveyId'
Notes
POST getAnswersBySurveyId
Gets a filtered list of answers that are defined for a given survey ID.
Note: It’s important to emphasize that “answers” do not refer a survey taker’s responses to questions, but rather to pre-defined answer choices for questions that have those.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which survey answers will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
The FilterGroup GroupOperator can be defined with the operators AND and OR. Here are the columns available for filters, their possible values if applicable, and the operators that can be used on them:
- QuestionId; identifier of the question; (Equals, NotEquals); for a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- LanguageId; identifier of the language; (Equals, NotEquals); for a readout of the survey’s languages, issue the call getLanguagesBySurveyId; if no LanguageId is defined in the filter you will receive answers in the default survey language.
- ScaleId; identifier of the scale; (Equals, NotEquals); for a readout of the survey’s scales, issue the call getScalesBySurveyId.
- AnswerShortCode; answer’s tag that is used to identify an answer by a different name; (Equals, NotEquals, Contains, NotContains)
- AnswerDataType; these are the possible values for AnswerDataType: ordinal (single and multi-type questions); rank-other; ordinal-other; text (short text questions); number; memo (long text questions); datetime; (Equals, NotEquals, Contains, NotContains)
- AnswerId; identifier of the answer; (Equals, NotEquals)
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. To find values for AnswerId and AnswerDataType, first issue getAnswersBySurveyId with no filters.
xmlIndent=[bool] Optional
Specifies whether or not the resulting XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetAnswersBySurveyIdResult=[string]
A collection of answers in XML representation. GetAnswersBySurveyIdResult has the following XML structure:
{
"GetAnswersBySurveyIdResult": "<Answers>
<Answer>
<AnswerId>1</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 1</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_1</AnswerShortCode>
<ModifiedDate />
</Answer>
<Answer>
<AnswerId>2</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 2</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_2</AnswerShortCode>
<ModifiedDate />
</Answer>
<Answer>
<AnswerId>3</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 3</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_3</AnswerShortCode>
<ModifiedDate />
</Answer>
</Answers>"
}
Here are definitions for the XML fields:
- AnswerId – Identifier of the answer. For a readout of the survey’s answers, issue the call getAnswersBySurveyId.
- QuestionId – Identifier of the question. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- ScaleId – Scales identify various answer groups for a given question. A question can have multiple answer groups if they are in a table. ScaleId is the identifier for these answer groups. For a readout of the survey’s scales, issue the call getScalesBySurveyId.
- AnswerDataType – Indicates the type of answer. These go hand-in-hand with question types. These are the possible values for AnswerDataType: ordinal (single and multi-type questions); rank-other; ordinal-other; text (short text questions); number; memo (long text questions); datetime.
- AnswerText – The text of an answer, as entered when the survey is created in Survey Builder. Empty for textbox-type questions where the ‘Store text responses as categorical’ option is not selected.
- AnswerWeight – Survey builders can place weights on the answers. This reflects the weight value on the answer.
- AnswerShortCode – Answer’s tag that is used to identify an answer by a different name.
- ModifiedDate – Date when the answer was saved; this value is only set by the data import process. Returned in ISO8601 format and the UTC time zone.
Note: The GetAnswersBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["GetAnswersBySurveyIdResult"].ToString();
Sample Response
{
"GetAnswersBySurveyIdResult": "<Answers>
<Answer>
<AnswerId>1</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 1</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_1</AnswerShortCode>
<ModifiedDate />
</Answer>
<Answer>
<AnswerId>2</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 2</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_2</AnswerShortCode>
<ModifiedDate />
</Answer>
<Answer>
<AnswerId>3</AnswerId>
<QuestionId>1</QuestionId>
<ScaleId>1</ScaleId>
<AnswerDataType>ordinal</AnswerDataType>
<AnswerText>Option 3</AnswerText>
<AnswerWeight>0</AnswerWeight>
<AnswerShortCode>OPTION_3</AnswerShortCode>
<ModifiedDate />
</Answer>
</Answers>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getAnswersBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["GetAnswersBySurveyIdResult"].ToString();
POST getEmailListImportErrorsV2
Gets a list of errors that occurred during the import of a given email list.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
dataImportId=[integer] Required
The ID of the email list whose errors will be retrieved.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"dataImportId":1206
}
Response Values
GetEmailListImportErrorsV2Result=[List]
A list of EmailImportErrorItemV2 objects. Contains the following elements:
- ColumnName – Name of the column in the import file where the error occurred.
- ColumnNumber – Number of the column in the import file where the error occurrred.
- ErrorDescription – Description of the error.
- ErrorDetails – Details of the error.
- RowNumber – Row number in the import file where the error occurred.
- RowValues – Values in the row of the import file where the error occurred.
- ColumnValue – Value in the column of the import file where the error occurred.
Sample Response
{
"GetEmailListImportErrorsV2Result":[
{
"ColumnName":"Q2 Email",
"ColumnNumber":2,
"ErrorDescription":"Duplicate email address",
"ErrorDetails":"graypye@gmail.com",
"RowNumber":6,
"RowValues":[
{
"ColumnName":"Q1 AuthKey",
"ColumnValue":"ak5"
},
{
"ColumnName":"Q2 Email",
"ColumnValue":"graypye@gmail.com"
},
{
"ColumnName":"Q3 Language",
"ColumnValue":"English"
},
{
"ColumnName":"Q4 First Name",
"ColumnValue":"Gray"
},
{
"ColumnName":"Q5 Last Name",
"ColumnValue":"Pye"
},
{
"ColumnName":"Q6 Salutation",
"ColumnValue":"Sir"
},
{
"ColumnName":"Q7 Other1",
"ColumnValue":"a"
},
{
"ColumnName":"Q8 Other2",
"ColumnValue":"c"
},
{
"ColumnName":"Q9 Other3",
"ColumnValue":"e"
},
{
"ColumnName>":"Q10 Other4",
"ColumnValue":"g"
},
{
"ColumnName":"Q11 Other5",
"ColumnValue":"i"
},
{
"ColumnName":"Q12 Other6",
"ColumnValue":"k"
},
{
"ColumnName":"Q13 Other7",
"ColumnValue":"m"
},
{
"ColumnName":"Q14 Other8",
"ColumnValue":"x"
},
{
"ColumnName":"Q15 Other9",
"ColumnValue":"x"
},
{
"ColumnName":"Q16 Other10",
"ColumnValue":"x"
}
]
}
]
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"dataImportId": 1206 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getEmailListImportErrorsV2'
Notes
POST getEmailListImportStatus
Gets the status of an email list import.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
dataImportId=[integer] Required
The ID of the data import, which is retrieved by calling newEmailListV2.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"dataImportId":1206
}
Response Values
GetEmailListImportStatusResult=(JSON object)
Response object for getEmailListImportStatus, which contains the following elements:
- ChooseManyAsSingleColumn – Unused by the API and therefore always returns as False.
- ColNumber – Column number that contained an error.
- CsvError – Unused.
- CurrentItemNum – Unused.
- DataImportName – Name of the data import, as specified in the MaritzCX platform.
- DataImportType – Integer type of the data import; typically will be a 13, which represents an API sample import.
- DelimiterCharacter – Character used to separate data values in the import file. Possible values are “,” and “;”.
- DeliverableId – Internal, not to be used by customer.
- EmailListId – Identifier of the email list.
- ErrorMessage – Message describing the error that was generated.
- ExceptionMessage – TBD
- FileName – Name of the email list data file.
- HasError – Boolean that indicates whether or not the email list import has an error.
- ImportStatus – Status of the import; possible values are: 1 = File uploaded – Data from the import file has been inserted into a staging table; 10 = Import complete – The import has successfully completed (END state); 12 = Mapping required – The import file has been uploaded to our system and the import process has started; 14 = Importing/Validating – The data from the staging table is being processed; 15 = Import error – There has been an error somewhere in the import process (END state); 16 = No invitees to import – After validation, there were not invitees left to import (END state); 20 = Creating TAC answers – Text as categorical answer creation has started.
- ItemCount – Unused.
- NotificationEmails – Email addresses of all notification recipients.
- OriginalFileName – Original filename of the imported file.
- RowNumber – Row number that contained an error.
- ScheduledImportDefinitionId – For an automated import, identifies the import definition.
- SurveyId – Identifier of the MaritzCX survey associated with the email list.
- SurveyName – Name of the MaritzCX survey associated with the email list.
Sample Response
{
"GetEmailListImportStatusResult": {
"ImportStatus": 10,
"CurrentItemNum": 0,
"ItemCount": 0,
"NotificationEmails": "foo.smith@allegiance.com,foosmith@gmail.com",
"SurveyId": 68,
"DataImportName": "myListName",
"FileName": "352bfd00-0afe-4cd7-9bcf-e7ddd5d9e375.csv",
"OriginalFileName": "",
"DelimiterCharacter": ",",
"ScheduledImportDefinitionId": "",
"SurveyName": "My Survey",
"DeliverableId": 0,
"EmailListId": 1190,
"CsvError": {
"HasError": true,
"ErrorMessage": "string",
"RowNumber": 1,
"ColNumber": 1,
"ExceptionMessage": "string"
},
"DataImportType": "ResponseImport",
"ChooseManyAsSingleColumn": true
}
}
Error Response
Error responses are detailed here.
Note: If you are using newEmailListV2 to import the file you can specify a notification email address, and that email address should receive a detailed import email, including the appropriate error code if applicable. If importing through the platform the notification email can be set during the import setup process.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"dataImportId": 1206 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getEmailListImportStatus'
Notes
We recommend at least a 10 second delay before calling getEmailListImportStatus after calling NewEmailListV2, then additional 10 second delays between subsequent calls to getEmailListImportStatus.
By default, getEmailListImportStatus enforces the following rate limit:
- You can call the endpoint up to once per minute.
POST getEmailListRecipientStatusListV2
Gets the status of all recipients in a given email list.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
emailListId=[int] Required
ID of the email list whose recipient status will be retrieved.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"emailListId":1190
}
Response Values
GetEmailListRecipientStatusListV2Result=[list]
Contains the following elements:
- AuthenticationKey – Authentication key for the associated survey.
- EmailAddress – Email address of the recipient.
- InvitationStatusCode – Status of the invitation. Can be any of the following values: 6 = Uploaded; 7 = Invited; 15, 17, 18 = Hard Bounce; 16 = Soft Bounce; 21 = Fatigued; 22 = Sampled Out (Opt Out)
- InvitedDate – Date and time when the invitation was sent, in the date format yyyy-MM-ddTHH:mm:ssZ. Returned in ISO8601 format and the UTC time zone.
- IsOptedOut – Boolean that indicates whether or not the recipient has opted out of survey invitations; possible values are “true” and “false”.
- ReminderDate – Date and time when the reminder was sent, in the date format yyyy-MM-ddTHH:mm:ssZ. Returned in ISO8601 format and the UTC time zone.
- ResponseStatusCode – Status of the response. Can be any of the following values: 0 = Completed; 2 = In Progress; 3 = Abandoned; 12 = No Response
Sample Response
{
"GetEmailListRecipientStatusListV2Result":[
{
"AuthenticationKey":"BZRSQ9",
"EmailAddress":"email1@gmail.com",
"InvitationStatusCode":6,
"InvitedDate": "2018-06-18T08:57:08Z",
"IsOptedOut":false,
"ReminderDate": "",
"ResponseStatusCode":12
},
{
"AuthenticationKey":"D4FE2E",
"EmailAddress":"email2@allegiance.com",
"InvitationStatusCode":6,
"InvitedDate": "2018-06-18T08:57:08Z",
"IsOptedOut":false,
"ReminderDate": "",
"ResponseStatusCode":12
},
{
"AuthenticationKey":"H599B4",
"EmailAddress":"email3@gmail.com",
"InvitationStatusCode":6,
"InvitedDate": "2018-06-18T08:57:08Z",
"IsOptedOut":false,
"ReminderDate": "",
"ResponseStatusCode":12
},
{
"AuthenticationKey":"UWDU5J",
"EmailAddress":"email4@gmail.com",
"InvitationStatusCode":6,
"InvitedDate": "2018-06-18T08:57:08Z",
"IsOptedOut":false,
"ReminderDate": "",
"ResponseStatusCode":12
},
{
"AuthenticationKey":"ZWWVCT",
"EmailAddress":"email5@gmail.com",
"InvitationStatusCode":6,
"InvitedDate": "2018-06-18T08:57:07Z",
"IsOptedOut":false,
"ReminderDate": "2018-06-25T12:40:37Z",
"ResponseStatusCode":12
}
]
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"emailListId": 1190 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getEmailListRecipientStatusListV2'
Notes
- You can call the endpoint up to once per minute.
POST getEmailListsBySurveyId
Returns a response list matching the given parameters.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Id of the survey the email lists should be provided for. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
xmlIndent=[bool] Optional
Specifies whether the resulting XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition MaxNumberResultRecords='...'>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
MaxNumberResultRecords will limit the result set of records to the given number of the latest email lists, so the n most recent email lists. MaxNumberResultRecords must be greater than 0, otherwise the error “MaxNumberResultRecords must be greater than 0” will be returned. If MaxNumberResultRecords is omitted, all email list records according to the query will be given back.
FilterGroup GroupOperator can be defined with the operators AND and OR. Regarding FilterColumn, the following list gives the columns available for filters, their possible values if applicable, and the operators that can be used on them:
- EmailListId – ID of the email list (Equals, NotEquals)
- Description – Filter on the description of the email list (Equals, NotEquals, Contains, NotContains)
- InvitedOn – Date when the email list was sent out (GreaterThan, LessThan, Between)
- UploadedOn – Date when the email list was requested (GreaterThan, LessThan, Between)
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone.
Sample Request
{
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId": 123,
"filterXml": "<FilterDefinition> <FilterGroup GroupOperator="AND"> <FilterCriteria> <FilterColumn>UploadedOn</FilterColumn> <FilterOperator>Between</FilterOperator> <FilterValue>2015-11-29T09:03:22Z</FilterValue> <FilterValue>2015-11-30T22:03:22Z</FilterValue> </FilterCriteria> </FilterGroup> </FilterDefinition>",
"xmlIndent": "true"
}
Response Values
GetEmailListsBySurveyIdResult=[string]
An XML representation of the email lists matching the given parameters. Contains the following elements:
- EmailLists – Array of email lists returned by the query.
- EmailList – One email list returned by the query, composed of the elements below.
- EmailListId – ID of the email list being retrieved.
- Description – Text description of the email list being retrieved.
- SurveyId – ID of the survey the email list is attached to.
- UploadedOn – Date when the email list was requested. Returned in ISO8601 format and the UTC time zone.
- InvitedOn – Date when the email list was sent out. Returned in ISO8601 format and the UTC time zone.
- IsRolling – Whether or not it is a daily rolling, automatically generated email list.
Note: The getEmailListsBySurveyId response contains an XML-formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getEmailListsBySurveyIdResult"].ToString();
Sample Response
HTTP Status Code: 200
{
"GetEmailListsBySurveyIdResult":"<EmailLists>
<EmailLists>
<EmailList>
<EmailListId>272</EmailListId>
<Description>Test1</Description>
<SurveyId>305</SurveyId>
<UploadedOn>2017-03-10T10:30:12Z</UploadedOn>
<InvitedOn />
<IsRolling>false</IsRolling>
</EmailList>
<EmailList>
<EmailListId>270</EmailListId>
<Description>Test2</Description>
<SurveyId>305</SurveyId>
<UploadedOn>2017-03-09T13:42:55Z</UploadedOn>
<InvitedOn />
<IsRolling>false</IsRolling>
</EmailList>
<EmailList>
<EmailListId>267</EmailListId>
<Description>Test3</Description>
<SurveyId>305</SurveyId>
<UploadedOn>2017-03-08T13:55:19Z</UploadedOn>
<InvitedOn />
<IsRolling>false</IsRolling>
</EmailList>
</EmailLists>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "<FilterDefinition> <FilterGroup GroupOperator="AND"> <FilterCriteria> <FilterColumn>UploadedOn</FilterColumn> <FilterOperator>Between</FilterOperator> <FilterValue>2015-11-29T09:03:22Z</FilterValue> <FilterValue>2015-11-30T22:03:22Z</FilterValue> </FilterCriteria> </FilterGroup> </FilterDefinition>",
"xmlIndent": "true", \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getEmailListsBySurveyId'
Notes
- You must have either the survey or site admin role to access this endpoint.
- The endpoint getEmailListsBySurveyId implements an export limitation. This default limit is defined as 50,000 email lists per hour.
-
The getEmailListsBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json LibraryJObject jsonObject = JObject.Parse(rawResponse);var validXmlString = jsonObject["getEmailListsBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getEmailListsBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getEmailListsBySurveyIdResult"].ToString();
POST getInvitationSchedulesBySurveyId
Gets a list of invitation schedules for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Optional
Specifies the survey for which invitation schedules will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition> <FilterGroup GroupOperator='...'> <FilterCriteria> <FilterColumn></FilterColumn> <FilterOperator></FilterOperator> <FilterValue></FilterValue> <FilterValue></FilterValue> </FilterCriteria> <FilterCriteria> ... </FilterCriteria> ... </FilterGroup> </FilterDefinition>
FilterGroup GroupOperator can be defined with the operators AND and OR.
FilterColumn can be defined for the columns UTCStartTime (date) and SampleId (int). For SampleId (int), only the operator “Equals” is allowed.
FilterOperator can be defined with the operators Equals, NotEquals, GreaterThan, LessThan, and Between.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone.
xmlIndent=[bool] Optional
Specifies whether the resulting XML is formatted with newlines and indentation. The allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetInvitationSchedulesBySurveyIdResult=[string]
List of scheduled invitations in XML representation. Contains the following elements:
- InvitationScheduleID – Unique integer identifier of the invitation schedule.
- SurveyID – The integer identifier of the survey for which invitations will be sent.
- StartTime – Definition of the start date and time when invitations will be sent (in local server time). Returned in ISO8601 format and the UTC time zone.
- Stagger – Maximum number of emails that will be sent out per hour per campaign.
- SendOpen – Start time when invitations will be sent. The time is 24 hour-based, where 0 = 12:00 AM and 2300 = 11:00 PM.
- SendClose – End time when sending out invitations will be stopped. The time is 24 hour-based, where 0 = 12:00 AM and 2300 = 11:00 PM.
- SendDays – Days when an invitation will be sent out. The integer represents a bit field with each bit set to indicate that the day is used to send out invitations: 1 = Sunday; 2 = Monday; 4 = Tuesday; 8 = Wednesday; 16 = Thursday; 32 = Friday; 64 = Saturday; 127 = all days.
- SampleIDs – Internal integer identifiers (comma-separated) of email lists for which the invitations will be sent.
- UTCStartTime – Definition of the start date and time when invitations will be sent (in UTC time), e.g. 2015-12-04T03:22:34.
- UTCOffset – UTC time offset in hours when invitations will be sent, e.g. +5.
- UTCOffsetInMinutes – UTC time offset in minutes when invitations will be sent, e.g. 300.
Note: The getInvitationSchedulesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getInvitationSchedulesBySurveyIdResult"].ToString();
Sample Response
{
"GetInvitationSchedulesBySurveyIdResult":"<InvitationSchedules>
<InvitationSchedule>
<InvitationScheduleID>123</InvitationScheduleID>
<SurveyID>38</SurveyID>
<StartTime>2015-12-04T03:22:34</StartTime>
<Stagger>1</Stagger>
<SendOpen>2</SendOpen>
<SendClose>3</SendClose>
<SendDays>4</SendDays>
<SampleIDs>123</SampleIDs>
<UTCStartTime>2015-12-04T03:22:34</UTCStartTime>
<UTCOffset>+2</UTCOffset>
<UTCOffsetInMinutes>0</UTCOffsetInMinutes>
</InvitationSchedule>
<InvitationSchedule>
<InvitationScheduleID>124</InvitationScheduleID>
<SurveyID>38</SurveyID>
<StartTime>2015-12-04T04:22:34</StartTime>
<Stagger>1</Stagger>
<SendOpen>2</SendOpen>
<SendClose>3</SendClose>
<SendDays>4</SendDays>
<SampleIDs>123,124</SampleIDs>
<UTCStartTime>2015-12-04T03:22:34</UTCStartTime>
<UTCOffset>+3</UTCOffset>
<UTCOffsetInMinutes>0</UTCOffsetInMinutes>
</InvitationSchedule>
</InvitationSchedules>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getInvitationSchedulesBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getInvitationSchedulesBySurveyIdResult"].ToString();
POST getLanguagesBySurveyId
Gets a list of languages for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which languages will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
The FilterGroup GroupOperator can be defined with the operators AND and OR. The FilterColumn can be defined for the columns LanguageName or LanguageDescription. The FilterOperator can be defined with the operators Equals, NotEquals, GreaterThan, LessThan, and Between.
- Only a single FilterGroup per FilterDefinition is supported.
- The “Between” FilterOperator requires 2 FilterValues. The order is not relevant.
xmlIndent=[bool] Optional
Specifies whether or not the resulting XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"",
"xmlIndent":"true"
}
Response Values
GetLanguagesBySurveyIdResult=[string]
A collection of languages in XML representation. GetLanguagesBySurveyIdResult has the following XML structure:
<Languages>
<SurveyLanguage>
<LanguageId></LanguageId>
<LanguageName></LanguageName>
<LanguageDescription></LanguageDescription>
<Default></Default>
</SurveyLanguage>
<SurveyLanguage>
…
</SurveyLanguage>
…
</Languages>
Here are definitions for the XML fields:
- LanguageId – Identifier of the survey language.
- LanguageName – Name of the language.
- LanguageDescripton – A language description (e.g. native language name).
- Default – True if the language is the survey’s default language, otherwise False.
Note: The getLanguagesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getLanguagesBySurveyIdResult"].ToString();
Sample Response
{
"GetLanguagesBySurveyIdResult":"
<Languages>
<SurveyLanguage>
<LanguageId>11</LanguageId>
<LanguageName>English</LanguageName>
<LanguageDescription>English</LanguageDescription>
<Default>true</Default>
</SurveyLanguage>
<SurveyLanguage>
<LanguageId>12</LanguageId>
<LanguageName>French</LanguageName>
<LanguageDescription>Français</LanguageDescription>
<Default>false</Default>
</SurveyLanguage>
<SurveyLanguage>
<LanguageId>13</LanguageId>
<LanguageName>German</LanguageName>
<LanguageDescription>Deutsch</LanguageDescription>
<Default>false</Default>
</SurveyLanguage>
</Languages>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getLanguagesBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getLanguagesBySurveyIdResult"].ToString();
POST getOptOuts
Returns an opt-out list matching the given parameters.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
sOptOutType=[string] Optional
Type of email opt-out; one of the following: Survey (the email address is opted out of only the particular survey specified by the surveyId), Site (the email address is opted out of all surveys from your site), Domain (all email addresses from the email domain are opted out of the survey). Note: “Site” in the API is equivalent to “Company” in the GUI.
surveyId=[string] Optional
If sOptOutType = “Survey”, the ID of the survey to be opted out. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterDefinitionXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition MaxNumberResultRecords="…"> <FilterGroup GroupOperator='…'> <FilterCriteria> <FilterColumn></FilterColumn> <FilterOperator></FilterOperator> <FilterValue></FilterValue> <FilterValue></FilterValue> </FilterCriteria> <FilterCriteria> … </FilterCriteria> … </FilterGroup> </FilterDefinition>
MaxNumberResultRecords will limit the result set of optouts records to the given number of the latest opt-outs, so the n most recent opt-outs. MaxNumberResultRecords must be greater than 0, otherwise an error “MaxNumberResultRecords must be greater than 0” will be returned. If MaxNumberResultRecords is omitted, all optouts records according to the query will be given back.
FilterGroup GroupOperator can be defined with the operators AND and OR. The following list gives the columns available for filters, their possible values if applicable, and the operators that can be used on them:
- OptOutEmail – Specified email addresses for the opt-opt (Equals, NotEquals, Contains, NotContains).
- OptOutType – Type of email opt-out; one of the following: Survey (the email address is opted out of only the particular survey specified by the surveyId), Site (the email address is opted out of all surveys from your site), Domain (all email addresses from the email domain are opted out of the survey).
- RequestedDate – Date when the opt-out was requested (GreaterThan, LessThan, Between).
- EmailListId – ID of the email list where the opt-out is used (Equals, NotEquals).
- Description – Filter on the description of the email list (Equals, NotEquals, Contains, NotContains).
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone.
surveyId=[int] Optional
A nullable survey id for the opt outs to be returned. If the surveyId is either null or zero then the sOptOutType should be ‘Site’ or ‘Domain’, if not then the sOptOutType should be ‘Survey’.
Sample Request
{
"token": "ef458ea7-5e44-4857-8e6b-d33d8691e0df",
"sOptOutType":"Site",
"surveyId":0,
"filterDefinitionXml":"<FilterDefinition><FilterGroup GroupOperator=\"OR\"><FilterCriteria><FilterColumn>RequestedDate</FilterColumn><FilterOperator>Between</FilterOperator><FilterValue Type=\"Date\">2009-07-16T08:28:01Z</FilterValue><FilterValue Type=\"Date\">2019-07-17T08:28:01Z</FilterValue></FilterCriteria> </FilterGroup></FilterDefinition>"
}
Response Values
GetOptOutsResult=[string]
An XML representation of the opt outs matching the given parameters. GetOptOutsResult has the following XML structure:
<OptOuts> <OptOutRecipient> <OptOutEmail></OptOutEmail> <OptOutType></OptOutType> <SurveyId></SurveyId> <RequestedDate></RequestedDate>; </OptOutRecipient> <OptOutRecipient> ... </OptOutRecipient> ... </OptOuts>
Here are definitions for the XML fields:
- OptOutEmail – The email address that has been opted out.
- OptOutType – Type of email opt-out; one of the following: Survey (the email address is opted out of only the particular survey specified by the surveyId), Site (the email address is opted out of all surveys from your site), Domain (all email addresses from the email domain are opted out of the survey). If OptOutType = “Site” then SurveyId = 0.
- SurveyId – ID of the survey that has been opted out of. Same as the identifier discussed in this Knowledge Center article.
- RequestedDate – Date and time when the opt-out request was made. Comes in ISO 8601 format; comes in the time zone of your local MaritzCX server: North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern.
Note: The getOptOuts response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getOptOutsResult"].ToString();
Sample Response
{
"GetOptOutsResult":"<OptOuts>
<OptOutRecipient>
<OptOutEmail>123@test.com</OptOutEmail>
<OptOutType>Survey</OptOutType>
<SurveyId>12</SurveyId>
<RequestedDate>2019-12-01T06:39:49</RequestedDate>
</OptOutRecipient>
<OptOutRecipient>
<OptOutEmail>kg@test.com</OptOutEmail>
<OptOutType>Survey</OptOutType>
<SurveyId>12</SurveyId>
<RequestedDate>2019-07-01T10:50:59</RequestedDate>
</OptOutRecipient>
<OptOutRecipient>
<OptOutEmail>randall.matlock@jetski.com</OptOutEmail>
<OptOutType>Site</OptOutType>
<SurveyId>0</SurveyId>
<RequestedDate>2019-02-15T16:23:06</RequestedDate>
</OptOutRecipient>
</OptOuts>"
}
Error Response
Error responses are detailed here.
Sample Call C#
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "ef458ea7-5e44-4857-8e6b-d33d8691e0df", \
"sOptOutType": "Site", \
"surveyId": 123, \
"filterDefinitionXml": "<FilterDefinition><FilterGroup GroupOperator=\"OR\"><FilterCriteria><FilterColumn>RequestedDate</FilterColumn><FilterOperator>Between</FilterOperator><FilterValue Type=\"Date\">2009-07-16T08:28:01Z</FilterValue><FilterValue Type=\"Date\">2019-07-17T08:28:01Z</FilterValue></FilterCriteria> </FilterGroup></FilterDefinition>" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getOptOuts'
Notes
- User must have the site admin role to access this endpoint.
- The endpoint getOptOuts implements an export limitation. The default limit is defined as 50,000 optouts per hour.
- The getOptOuts response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.Here is sample C# code that does this:
// Using the Newtonsoft.Json LibraryJObject jsonObject = JObject.Parse(rawResponse);var validXmlString = jsonObject["getOptOutsResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getOptOutsResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getOptOutsResult"].ToString();
POST getQuestionsBySurveyId
Gets a filtered list of questions for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which questions will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
The FilterGroup GroupOperator can be defined with the operators AND and OR. Here are the columns available for filters, their possible values if applicable, and the operators that can be used on them:
- QuestionId; (Equals, NotEquals)
- QuestionText; (Equals, NotEquals, Contains, NotContains)
- LanguageId; (Equals, NotEquals)
- QuestionShortCode; (Equals, NotEquals, Contains, NotContains)
- QuestionAlias; (Equals, NotEquals, Contains, NotContains)
- QuestionStatus; [0 = active; 1 = deleted]; (Equals, NotEquals)
- QuestionType; [single, multi, text, memo, etc.]; (Equals, NotEquals)
Note: 1. Only a single FilterGroup per FilterDefinition is supported; 2. LanguageId will filter the answers to appear in the specified language – to determine the languages available for the survey, first call getLanguagesBySurveyId; 3. If no LanguageId is defined in the filter you will receive answers in the default survey language.
xmlIndent=[bool] Optional
Specifies whether or not the resulting XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetQuestionsBySurveyIdResult=[string]
A collection of questions in XML representation. GetQuestionsBySurveyIdResult has the following XML structure:
<Questions>
<Question>
<QuestionId></QuestionId>
<QuestionText></QuestionText>
<QuestionShortCode></QuestionShortCode>
<QuestionAlias></QuestionAlias>
<QuestionType></QuestionType>
<QuestionStatus></QuestionStatus>
<ExtendedType></ExtendedType>
</Question>
<Question>
...
</Question>
...
</Questions>
Here are definitions for the XML fields:
- QuestionId – Identifier of the question.
- QuestionText – The actual text of the question.
- QuestionShortCode – Question’s tag. This is used to identify a question by a different name, and is usually used to prepopulate survey answers (omitted if empty).
- QuestionAlias – An alias to be used in Reporting as a short-form version of the question’s full text (omitted if empty).
- QuestionType – Indicates the type of the question: Single = single-select categorical; Multi = multi-select categorical; Text = short-text; Memo = paragraph-type question.
- QuestionStatus – Whether a question is deleted or not; 0 = active, 1 = deleted.
- ExtendedType – There are several types of extensions to questions – extensions add functionality to a given question type. The most common values for ExtendedType are 4 = Text as categorical, 7 or 8 = Text Analytics, and 0=none.
Note: The getQuestionsBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getQuestionsBySurveyIdResult"].ToString();
Sample Response
{
"GetQuestionsBySurveyIdResult":"<Questions>
<Question>
<QuestionId>361</QuestionId>
<QuestionText>What's your number</QuestionText>
<QuestionShortCode>number</QuestionShortCode>
<QuestionAlias>The number</QuestionAlias>
<QuestionType>single</QuestionType>
<QuestionStatus>0</QuestionStatus>
<ExtendedType>0</ExtendedType>
</Question>
</Questions>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getQuestionsBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getQuestionsBySurveyIdResult"].ToString();
POST getRemainingApiExportQuota
Provides the remaining number of records that can be exported by an API method until the defined limit for a time period is reached.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Optional
A survey id (you can provide a -1 if not required). To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
apiMethodName=[string] Required
Name of the API method to be checked (there can be different limits for different API methods).
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"apiMethodName":"GetResponsesBySurveyId"
}
Response Values
GetRemainingApiExportQuotaResult=[int]
GetRemainingApiExportQuotaResult can have one of the following values:
- > 0 – this value is the maximum number of records that can be exported
- = 0 – the maximum number of records for export has been exceeded
- < 0 - there is no limitation
Sample Response
{
"GetRemainingApiExportQuotaResult":"50000"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"apiMethodName": "GetResponsesBySurveyId" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getRemainingApiExportQuota'
Notes
POST getReminderSchedulesBySurveyId
Gets a list of scheduled reminders for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Optional
Specifies the survey for which scheduled reminders will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition> <FilterGroup GroupOperator='...'> <FilterCriteria> <FilterColumn></FilterColumn> <FilterOperator></FilterOperator> <FilterValue></FilterValue> <FilterValue></FilterValue> </FilterCriteria> <FilterCriteria> ... </FilterCriteria> ... </FilterGroup> </FilterDefinition>
FilterGroup GroupOperator can be defined with the operators AND and OR.
FilterColumn can be defined for the columns UTCStartTime (date) and SampleId (int). For SampleId (int), only the operator “Equals” is allowed.
FilterOperator can be defined with the operators Equals, NotEquals, GreaterThan, LessThan, and Between.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone.
xmlIndent=[bool] Optional
Specifies whether the resulting XML is formatted with newlines and indentation. The allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetReminderSchedulesBySurveyIdResult=[string]
List of scheduled reminders in XML representation. GetReminderSchedulesBySurveyIdResult has the following XML structure:
<ReminderSchedules>
<ReminderSchedule>
<ReminderScheduleID></ReminderScheduleID>
<SurveyID></SurveyID>
<StartTime></StartTime>
<Stagger></Stagger>
<SendOpen></SendOpen>
<SendClose></SendClose>
<SendDays></SendDays>
<SampleIDs></SampleIDs>
<UTCStartTime></UTCStartTime>
<UTCOffset></UTCOffset>
<UTCOffsetInMinutes></UTCOffsetInMinutes>
<ReminderSchedule></ReminderSchedule>
<ReminderScheduleID></ReminderScheduleID>
<SurveyID></SurveyID>
<StartTime></StartTime>
<Stagger></Stagger>
<SendOpen></SendOpen>
<SendClose></SendClose>
<SendDays></SendDays>
<SampleIDs></SampleIDs>
<UTCStartTime></UTCStartTime>
<UTCOffset></UTCOffset>
<UTCOffsetInMinutes></UTCOffsetInMinutes>
</ReminderSchedule>
<ReminderSchedule>
...
</ReminderSchedule>
...
</ReminderSchedules>
Here are definitions for the XML fields:
- ReminderScheduleID – Unique integer identifier of the reminder schedule.
- SurveyID – The integer identifier of the corresponding survey.
- StartTime – Definition of the start date and time when reminders will be sent out (in local server time).
- Stagger – Maximum number of emails that will be sent out per hour per campaign.
- SendOpen – Start time when reminders will be sent out. The time is 24 hour-based, where 0 = 12:00 AM and 2300 = 11:00 PM.
- SendClose – End time when sending out reminders will be stopped. The time is 24 hour-based, where 0 = 12:00 AM and 2300 = 11:00 PM.
- SendDays – Days when a reminder will be sent out. The integer represents a bit field with each bit set to indicate that the day is used to send out reminders: 1 = Sunday; 2 = Monday; 4 = Tuesday; 8 = Wednesday; 16 = Thursday; 32 = Friday; 64 = Saturday; 127 = all days.
- SampleIDs – Internal integer identifiers (comma-separated) of email lists for which the reminders will be sent out.
- UTCStartTime – Definition of the start date and time when reminders will be sent out (in UTC time), e.g. 2015-12-04T03:22:34.
- UTCOffset – UTC time offset in hours when reminders will be sent out, e.g. +5.
- UTCOffsetInMinutes – UTC time offset in minutes when reminders will be sent out, e.g. 300.
Note: The getReminderSchedulesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getReminderSchedulesBySurveyIdResult"].ToString();
Sample Response
{
"GetReminderSchedulesBySurveyIdResult":"<ReminderSchedules>
<ReminderSchedule>
<ReminderScheduleID>123</ReminderScheduleID>
<SurveyID>38</SurveyID>
<StartTime>2015-12-04T03:22:34</StartTime>
<Stagger>1</Stagger>
<SendOpen>2</SendOpen>
<SendClose>3</SendClose>
<SendDays>4</SendDays>
<SampleIDs>123</SampleIDs>
<UTCStartTime>2015-12-04T03:22:34</UTCStartTime>
<UTCOffset>+2</UTCOffset>
<UTCOffsetInMinutes>0</UTCOffsetInMinutes>
</ReminderSchedule>
<ReminderSchedule>
<ReminderScheduleID>124</ReminderScheduleID>
<SurveyID>38</SurveyID>
<StartTime>2015-12-04T04:22:34</StartTime>
<Stagger>1</Stagger>
<SendOpen>2</SendOpen>
<SendClose>3</SendClose>
<SendDays>4</SendDays>
<SampleIDs>123,124</SampleIDs>
<UTCStartTime>2015-12-04T03:22:34</UTCStartTime>
<UTCOffset>+3</UTCOffset>
<UTCOffsetInMinutes>0</UTCOffsetInMinutes>
</ReminderSchedule>
</ReminderSchedules>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getReminderSchedulesBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getReminderSchedulesBySurveyIdResult"].ToString();
POST getRespondentsBySurveyId
Gets a list of survey respondents for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which respondent records will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition MaxNumberResultRecords="…">
<FilterGroup GroupOperator='…'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
…
</FilterCriteria>
…
</FilterGroup>
</FilterDefinition>
MaxNumberResultRecords will limit the result set of respondents records to the given number, starting with the most recent respondent. MaxNumberResultRecords must be greater than 0, otherwise an error “MaxNumberResultRecords must be greater than 0” will be returned. If MaxNumberResultRecords is omitted, all respondents’ records according to the query will be returned.
FilterGroup GroupOperator can be defined with the operators AND and OR.
FilterColumn can be defined with following parameters:
- CompletedDate – Date when the survey was completed.
- LoadDate – Date when the survey was loaded into the system.
- LanguageId – Integer that indicates the survey language. For a readout of the survey’s languages, issue the call getLanguagesBySurveyId.
- CompletedSinceMinutes – Integer that limits the result set of respondents to the last n minutes since the survey was completed; note that you cannot use a negative number here – you will receive an error if you do.
- LoadedSinceMinutes – Integer that limits the result set of respondents to the last n minutes since the record was loaded into the system.
- RespondentState – String; values can be “completed”, “in progress”, or “abandoned”.
FilterOperator can be defined with the operators Equals, NotEquals, GreaterThan, LessThan, and Between.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone.
xmlIndent=[bool] Optional
Specifies whether the result XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetRespondentsBySurveyIdResult=[string]
List of survey respondent records in XML representation. GetRespondentsBySurveyIdResult has the following XML structure:
<Respondents>
<Respondent>
<RespondentID></RespondentID>
<RespondentKey></RespondentKey>
<SurveyID></SurveyID>
<LanguageID></LanguageID>
<OriginType></OriginType>
<CompletedDate></CompletedDate>
<LoadDate></LoadDate>
<RespondentState></RespondentState>
<StartDate></StartDate>
</Respondent>
<Respondent>
...
</Respondent>
...
</Respondents>
Here are definitions for the XML fields:
- RespondentID – Identifier of the respondent associated with the response.
- RespondentKey – If authentication is turned on, this value matches the authentication key used to take the survey; if authentication is off this field is blank.
- SurveyID – Identifier of the survey that the response belongs to.
- LanguageID – Identifier of the survey language. For a readout of the survey’s languages, issue the call getLanguagesBySurveyId.
- OriginType – This is the origin of the survey reponse. Can be one of the following: Web, Survey Management API, DataImportWizard.
- CompletedDate – Date on which the survey was completed.
- LoadDate – Date on which the survey was loaded into the system.
- RespondentState – State in which the respondent has left the survey. Can be Completed, In Progress, or Abandoned.
- StartDate – Date when the survey response was begun.
Notes: 1. All date values are returned in ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 2. All date values are returned in UTC time zone. 3. The GetRespondentsBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["GetRespondentsBySurveyIdResult"].ToString();
Note: All queries are performed in the database time zone where the server is located. US Production – Central Time Zone, EMEA – Central European, Australia – Australian Eastern. For the Survey Management API to function correctly, you must convert your local time to UTC. www.timeanddate.com is a useful tool to manage this. On it, select Time Zones | Time Zone Converter, input your local time zone, and select “Include UTC Time in Results”. You can then see the UTC time that will be needed.
Sample Response
{
“GetRespondentsBySurveyIdResult”:”
<Respondents>
<Respondent>
<RespondentId>2186</RespondentId>
<RespondentKey>YN76SK</RespondentKey>
<SurveyId>38</SurveyId>
<LanguageId>51</LanguageId>
<OriginType>Web</OriginType>
<CompletedDate>2015-12-04T03:22:34Z</CompletedDate>
<LoadDate>2015-12-04T03:22:34Z</LoadDate>
<RespondentState>Completed</RespondentState>
<StartDate>2015-12-04T03:22:27Z</StartDate>
</Respondent>
<Respondent>
<RespondentId>2187</RespondentId>
<RespondentKey>YPQFGS</RespondentKey>
<SurveyId>38</SurveyId>
<LanguageId>51</LanguageId>
<OriginType>Web</OriginType>
<CompletedDate>2015-12-04T03:26:00Z</CompletedDate>
<LoadDate>2015-12-04T03:26:00Z</LoadDate>
<RespondentState>Completed</RespondentState>
<StartDate>2015-12-04T03:25:53Z</StartDate>
</Respondent>
</Respondents>”
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>CompletedDate</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>2015-12-04T03:26:00Z</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getRespondentsBySurveyId'
Notes
- The endpoint getRespondentsBySurveyId implements an export limitation. The default limit is defined as 50,000 respondents per hour.
- The getRespondentsBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json LibraryJObject jsonObject = JObject.Parse(rawResponse);var validXmlString = jsonObject["getRespondentsBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getRespondentsBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getRespondentsBySurveyIdResult"].ToString();
POST getResponsesBySurveyId
Gets a list of survey response records for a given survey ID.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which response records will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition MaxNumberResultRecords=”…”>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
MaxNumberResultRecords will limit the result set of respondents records to the given number, starting with the most recent respondent. MaxNumberResultRecords must be greater than 0, otherwise an error “MaxNumberResultRecords must be greater than 0” will be returned. If MaxNumberResultRecords is omitted, all respondents’ records according to the query will be returned.
FilterGroup GroupOperator can be defined with the operators AND and OR.
FilterColumn can be defined with following parameters:
- CompletedDate – Date on which the survey was completed.
- ModifiedDate – Date on which the survey was last modified.
- RespondentId – Integer that identified the survey respondent.
- RespondentKey – If authentication is turned on, this value matches the authentication key used to take the survey.
- SinceMinutes – Integer that limits the result set of responses to the latest n minutes.
- QuestionIds – Comma-separated list of integers, e.g. 1234 or 1234, 12345. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- AnswerIds – Comma-separated list of integers, e.g. 1234 or 1234, 12345. For a readout of the survey’s answers, issue the call getAnswersBySurveyId.
.
FilterOperator can be defined with the following operators: Equals, NotEquals, GreaterThan, LessThan, and Between.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone. 5. The FilterValue for SinceMinutes must be an integer representing the number of minutes.
xmlIndent=[bool] Optional
Specifies whether the result XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>RespondentId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>12345</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetResponsesBySurveyIdResult=[string]
A collection of survey responses in XML representation. GetResponsesBySurveyIdResult has the following XML structure:
<Responses>
<Question>
<ResponseId></ResponseId>
<SurveyId></SurveyId>
<RespondentId></RespondentId>
<QuestionId></QuestionId>
<ScaleId></ScaleId>
<AnswerId></AnswerId>
<ResponseText></ResponseText>
<ResponseMemo></ResponseMemo>
<ResponseRank></ResponseRank>
<ResponseState></ResponseState>
<CompletedDate></CompletedDate>
<ModifiedDate></ModifiedDate>
<LanguageId></LanguageId>
<ResponseNum></ResponseNum>
<ResponseDate></ResponseDate>
</Response>
<Response>
...
</Response>
...
</Responses>
Here are definitions for the XML fields:
- ResponseId – Identifier of a response; within the return XML there may be one or more responses.
- SurveyId – Identifier of the survey that the response belongs to.
- RespondentId – Identifier of the respondent associated with the response.
- QuestionId – Identifier of the question answered in the response. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- ScaleId – Identifier of the answer group associated with the question. Scales identify various answer groups for a given question. Every question has at least one scale, but only table questions can have multiple answer groups (scales). For a readout of the survey’s scales, issue the call getScalesBySurveyId.
- AnswerId – Identifier of an answer. For a readout of the survey’s answers, issue the call getAnswersBySurveyId. Multiple respondents may have answered a question the same way. In that case multiple respondents may have the same AnswerId in their corresponding response records.
- ResponseText – The text that is entered by a survey respondent to a Short, Numeric, or Date Textbox type question. Empty for other question types.
- ResponseMemo – The text that is entered by a survey respondent to a Long Textbox type question. Empty for other question types.
- ResponseRank – The score chosen by a survey respondent to a rank-type question. The value of the ResponseRank reflects the ordinal position of the answer. Zero for other question types.
- ResponseState – Status of the survey response; Collected = 0, In progress = 2, Abandoned = 3.
- ResponseDate – The date that is entered by a survey respondent to a Date Textbox type question (same as Response.ResponseText, converted to a DateTime data type). Empty for other question types.
- LanguageId – Identifier of the language the survey was delivered in for the respondent. The list of languages can be retrieved by calling the endpoint getLanguagesBySurveyId.
- ResponseNum – The number that is entered by a survey respondent to a Numeric Textbox type question (same as Response.ResponseText, converted to an integer data type). Zero for other question types.
- CompletedDate – Date on which the survey was completed.
- ModifiedDate – Date on which the survey was last modified.
Notes: 1. All date values are returned in ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 2. All date values are returned in UTC time zone. 3. The getResponsesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object. 4. The getResponsesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getResponsesBySurveyIdResult"].ToString();
Sample Response
{
“GetResponsesBySurveyIdResult”:”<Responses>
<Response>
<ResponseId>27155</ResponseId>
<SurveyId>38</SurveyId>
<RespondentId>2186</RespondentId>
<QuestionId>367</QuestionId>
<ScaleId>387</ScaleId>
<AnswerId>3126</AnswerId>
<ResponseText>bla</ResponseText>
<ResponseMemo>moreblabla</ResponseMemo>
<ResponseRank>0</ResponseRank>
<ResponseState>0</ResponseState>
<CompletedDate>2015-12-04T03:22:34</CompletedDate>
<ModifiedDate>2015-12-04T03:22:42</ModifiedDate>
<LanguageId>51</LanguageId>
<ResponseNum>0</ResponseNum>
<ResponseDate />
</Response>
<Response>
<ResponseId>27156</ResponseId>
<SurveyId>38</SurveyId>
<RespondentId>2187</RespondentId>
<QuestionId>367</QuestionId>
<ScaleId>387</ScaleId>
<AnswerId>3126</AnswerId>
<ResponseText>blabla</ResponseText>
<ResponseMemo>moreblabla</ResponseMemo>
<ResponseRank>0</ResponseRank>
<ResponseState>0</ResponseState>
<CompletedDate>2015-12-04T03:26:00</CompletedDate>
<ModifiedDate>2015-12-04T03:26:10</CompletedDate>
<LanguageId>51</LanguageId>
<ResponseNum>0</ResponseNum>
<ResponseDate />
</Response>
</Responses>”
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>RespondentId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>12345</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getResponsesBySurveyId'
Notes
- The endpoint getResponsesBySurveyId implements an export limitation. The default limit is defined as 50,000 responses per hour, where one response means the set of answers a respondent has given to complete a survey (i.e. all the answers contained in one survey response).
-
The getResponsesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json LibraryJObject jsonObject = JObject.Parse(rawResponse);var validXmlString = jsonObject["getResponsesBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getResponsesBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getResponsesBySurveyIdResult"].ToString();
POST getScalesBySurveyId
A scale is a group of answers for a question; although present for all question types, it is only significant for table questions in which you might have multiple answer groups for the same question.
getScalesBySurveyId gets a list of question scales for a given survey ID.
For more information on scales in the MaritzCX platform, see this Knowledge Center article:
Talk to your MaritzCX account rep if you need access to the Knowledge Center.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which question scales will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
FilterGroup GroupOperator can be defined with the operators AND and OR.
The FilterColumn can be defined for the columns QuestionId (int), ScaleId (int), ScaleText (string), ScaleShortCode (string), ScaleStatus (int, Active = 0, Deleted = 1). The FilterOperator can be defined with the operators Equals, NotEquals, Contain, and NotContain.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
xmlIndent=[bool] Optional
Specifies whether the resulting XML is formatted with newlines and indentation. The allowed parameters are true and false.
Sample Request
{
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId": 123,
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent": "true"
}
Response Values
GetScalesBySurveyIdResult=[string]
A collection of scales in XML representation. GetScalesBySurveyIdResult has the following XML structure:
<Scales>
<Scale>
<Scaleid></Scaleid>
<QuestionId></QuestionId>
<ScaleText></ScaleText>
<ScaleType></ScaleType>
<ScaleShortCode></ScaleShortCode>
<ScaleStatus></ScaleStatus>
</Scale>
<Scale>
...
</Scale>
...
</Scales>
Here are definitions for the XML fields:
- Scaleid – Unique integer identifier of the scale.
- QuestionId – The integer identifier of the corresponding question. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- ScaleText – The text of the scale.
- ScaleType – The type of the scale: single, multi, rank, text, or memo.
- ScaleShortCode – Unique text identification of the scale.
- ScaleStatus – The status of the scale: 0 – scale is active; 1 – scale is deleted.
Note: The getScalesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getScalesBySurveyIdResult"].ToString();
Sample Response
{
"GetScalesBySurveyIdResult":
"<Scales>
<Scale>
<ScaleId>381</ScaleId>
<QuestionId>361</QuestionId>
<ScaleText></ScaleText>
<ScaleType>single</ScaleType>
<ScaleStatus>0</ScaleStatus>
</Scale>
</Scales>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator=’AND’>
<FilterCriteria>
<FilterColumn>QuestionId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": "true" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getScalesBySurveyId'
Notes
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getScalesBySurveyIdResult"].ToString();
POST getSurveyInvitationTemplates
Templates are used to give a standard form to email invitations and reminders. getSurveyInvitationTemplates gets the list of survey invitation templates owned by the authenticated user.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
ID of the survey the invitation templates should be provided for. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"surveyId":21
}
Response Values
GetSurveyInvitationTemplatesResult=[array]
Top-level response object returned by this endpoint, formed by JSON key/value pairs embedded in HTML. Composed of the following children:
InvitationTemplatesEmailList=[array]
Second-level response object returned by this endpoint, detailed in the Appendix.
SurveyId=[int]
Identifier of the survey.
TemplateType=[int]
Type of the template; possible values are “0” for invitation and “1” for reminder.
Sample Response
{
"GetSurveyInvitationTemplatesResult": {
"InvitationTemplatesEmailList": [
{
"InvitationtemplateId": 8101,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "<!DOCTYPE html>
<html>
<head>
<title></title>
</head>
<body style="background-color: #ffffff; margin: 0px;">
<table cellspacing="0" id="template" style="background-color: #ffffff; width: 100%;">
<tbody>
<tr>
<td style="text-align: center;">
<table bgcolor="#ffffff" id="survey" style="padding: 10px; margin: 20px auto; background-color: #ffffff; min-height: 504px;" width="80%">
<tbody>
<tr>
<td style="vertical-align: top; text-align: left;">
<div id="canvas" style="font-family: Helvetica, Arial, sans-serif; font-size: 12px; color: #333333; font-weight: normal; font-style: normal; text-decoration: none; text-align: left; vertical-align: top;"><!--INVITATION TEXT DEFAULT-->
<p>Dear [FIRST NAME],</p>
<p>In our continued effort to serve you better we’d like you to rate your current experience with us. Please provide your feedback on how we’re doing and any improvements you’d like to see.</p>
<p><a href="[SURVEY URL]"><strong>Please click here to provide your feedback</strong></a></p>
<p>Thanks in advance for your valuable time and input. As always, we look forward to serving you.</p>
Thank you
<p> </p>
<hr style="border:1px solid #aaa" />
<ul>
<li><span style="font-size:11px;">This email was sent to: [EMAIL ADDRESS]. If the above link does not work, copy and paste the following URL into your web browser:[SURVEY URL]</span></li>
<li><span style="font-size:11px;">If you would no longer like to receive these types of emails, please <a href="[OPTOUT URL]">opt out</a></span></li>
<li><span style="font-size:11px;">We are working with <a href="http://www.maritzcx.com">MaritzCX</a>, an independent customer experience firm, to conduct the survey and analyze the results. <a href="http://www.maritzcx.com/privacy-policy">MaritzCX privacy policy</a></span></li>
<li><span style="font-size:11px;">Please do not reply directly to this invitation.</span></li>
</ul>
</div>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</body>
</html>
",
"Subject": "Your feedback is vital to serving you better"
},
{
"InvitationtemplateId": 8120,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "<!DOCTYPE html><html><body><h1>My First Template</h1><p>My first template.</p></body></html>",
"Subject": "Template for doc"
}
],
"Surveyid": 138500,
"TemplateType": 0
}
}
If no invitations are found for a survey, this result will appear:
{
"GetSurveyInvitationTemplatesResult":{
"InvitationTemplatesEmailList":[
],
"Surveyid":210,
"TemplateType":0
}
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"surveyId": 21 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getSurveyInvitationTemplates'
Notes
POST getSurveyList
Returns a list of all surveys the authenticated user has access to.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
FilterGroup GroupOperator can be defined with the operators AND and OR.
The FilterColumn can be defined for the columns CreatedDate and LastModifiedDate. The FilterOperator can be defined with the operators Equals, NotEquals, Contain, and NotContain.
Note: 1. Only a single FilterGroup per FilterDefinition is supported.
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43"
}
Response Values
GetSurveyListResult=[List
A list of SurveyListItems. It contains the following elements:
- Active – Boolean value that indicates whether or not the survey is active; can be either “true” or “false”.
- CreatedDate – When the survey was created. Comes in ISO 8601 format; comes in the time zone of your local MaritzCX server: North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern.
- CutOffDate – When the survey becomes inactive. Comes in ISO 8601 format; comes in the time zone of your local MaritzCX server: North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern.
- Description – The survey’s description; shows up within the UI as the name of the survey.
- InactiveDate – If the survey has been deactivated, the date when it was. Comes in ISO 8601 format; comes in the time zone of your local MaritzCX server: North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern.
- LastModifiedDate – The date when the survey was last modified. Comes in ISO 8601 format; comes in the time zone of your local MaritzCX server: North America – Central Time Zone, EMEA – Central European, APAC – Australian Eastern.
- OwnerFirstName – First name of the survey owner. The Owner is initially whichever user created the survey, however survey ownership can be transferred so it’s whichever user currently owns the survey. There is only 1 owner per survey.
- OwnerLastName – Last name of the survey owner.
- OwnerEmail – Primary email address for the owner. This is sometimes also the username, but not always.
- Source – Source of the survey. Possible values are: 1 – Source is Bonfire; 0 – Source is Desktop Builder.
- SurveyCode – Unique text identification of the survey (e.g. EHJF2K).
- SurveyId – Unique integer identification of the survey (e.g. 1234).
- UserId – Unused.
Sample Response
{
"GetSurveyListResult":[
{
"Active":true,
"CreatedDate":""
"CutOffDate":null,
"Description":"First Survey",
"InactiveDate":null,
"LastModifiedDate":""
"OwnerEmail":"rmatlock@hotmail.com"
"OwnerFirstName":"Randy"
"OwnerLastName""Matlock"
"Source":1,
"SurveyCode":"4JANRX",
"SurveyId":1
"UserId":"17"
},
{
"Active":false,
"CreatedDate":
"CutOffDate":null,
"Description":"Second Survey",
"InactiveDate":null,
"LastModifiedDate":""
"OwnerEmail":"bsmith@hotmail.com"
"OwnerFirstName":"Bill"
"OwnerLastName":"Smith"
"Source":1,
"SurveyCode":"MP8TF5",
"SurveyId":2
"UserId":"19"
},
{
"Active":true,
"CreatedDate":""
"CutOffDate":null,
"Description":"Third Survey",
"InactiveDate":null,
"LastModifiedDate":""
"OwnerEmail":"frogan@hotmail.com"
"OwnerFirstName":"Frank"
"OwnerLastName":"Rogan"
"Source":1,
"SurveyCode":"Y43KDW",
"SurveyId":3
"UserId":"21"
}
]
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"filterXml": "string" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getSurveyList'
Notes
POST getSurveyReminderTemplates
Templates are used to give a standard form to email invitations and reminders. getSurveyReminderTemplates gets the list of survey reminder templates owned by the authenticated user.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Id of the survey the reminder templates should be provided for. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"surveyId":21
}
Response Values
GetSurveyReminderTemplatesResult=[array]
Top-level response object returned by this endpoint, formed by JSON key/value pairs embedded in HTML. Composed of the following children:
InvitationTemplatesEmailList=[array]
Second-level response object returned by this endpoint, detailed in the Appendix.
SurveyId=[int]
Identifier of the survey.
TemplateType=[int]
Type of the template; possible values are “0” for invitation and “1” for reminder.
Sample Response
{
"GetSurveyReminderTemplatesResult": {
"InvitationTemplatesEmailList": [
{
"InvitationtemplateId": 8121,
"LanguageId": 446334,
"LanguageName": "English",
"MessageBody": "<!DOCTYPE html><html><body><h1>My First Reminder</h1><p>This is a reminder.</p></body></html>",
"Subject": "Test Reminder for Doc"
}
],
"Surveyid": 138500,
"TemplateType": 1
}
}
If no reminders are found for survey “210”, this response will appear:
{
"GetSurveyReminderTemplatesResult":{
"InvitationTemplatesEmailList":[
],
"Surveyid":210,
"TemplateType":1
}
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"surveyId": 21 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getSurveyReminderTemplates'
Notes
POST getTextAnalyticsResponsesBySurveyId
Gets a list of survey response records for a given survey ID that is enriched with categorization data from text analytics; provides the possibility to define additional filter criteria for this type of data.
Note: If text analytics is not used for a survey the result will be the same as for the endpoint getResponsesBySurveyId, as discussed here.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which responses enriched by text analytics will be returned. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
filterXml=[string] Optional
A parameter in XML format to filter the result records. The filter must have the following XML format:
<FilterDefinition MaxNumberResultRecords=”…”>
<FilterGroup GroupOperator='...'>
<FilterCriteria>
<FilterColumn></FilterColumn>
<FilterOperator></FilterOperator>
<FilterValue></FilterValue>
<FilterValue></FilterValue>
</FilterCriteria>
<FilterCriteria>
...
</FilterCriteria>
...
</FilterGroup>
</FilterDefinition>
MaxNumberResultRecords will limit the result set of respondents records to the given number, starting with the most recent respondent. MaxNumberResultRecords must be greater than 0, otherwise an error “MaxNumberResultRecords must be greater than 0” will be returned. If MaxNumberResultRecords is omitted, all respondents’ records according to the query will be returned.
FilterGroup GroupOperator can be defined with the operators AND and OR.
FilterColumn can be defined with following parameters:
- CompletedDate – Date on which the survey was completed.
- ModifiedDate – Date on which the survey was last modified.
- RespondentId – Integer that identified the survey respondent.
- RespondentKey – If authentication is turned on, this value matches the authentication key used to take the survey.
- SinceMinutes – Integer that limits the result set of responses to the latest n minutes.
- QuestionIds – Comma-separated list of integers, e.g. 1234 or 1234, 12345; for a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- AnswerIds – Comma-separated list of integers, e.g. 1234 or 1234, 12345; for a readout of the survey’s answers, issue the call getAnswersBySurveyId.
Special columns for text analytics data:
- Level1,…,Level7 – Category names from text analytics from level 1 (the main category) to level 7 (the most detailed subcategory). Not all levels are filled for every text analytics item.
- Sentiment – The categorization’s sentiment, can be -1 = negative, 0 = neutral or 1 = positive.
FilterOperator can be defined with the following operators: Equals, NotEquals, GreaterThan, LessThan, and Between.
Notes: 1. Only a single FilterGroup per FilterDefinition is supported. 2. The “Between” FilterOperator requires 2 FilterValues. The order is not relevant. 3. The FilterValue for date fields must use ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 4. The FilterValue for date fields must use the UTC time zone. 5. The FilterValue for SinceMinutes must be an integer representing the number of minutes. 6. Filter definitions for the endpoint getResponsesBySurveyId can be used for this endpoint too without changes, but not vice versa, except the special filter columns for text analytics data are not used.
xmlIndent=[bool] Optional
Specifies whether the result XML structure is formatted with newlines and indentation. Allowed parameters are true and false.
allResponses=[bool] Optional
Specifies which responses should be exported:
- False [default] – Only responses with text analytics data will be exported
- True – All responses will be exported, both those with and without text analytics data. This is essentially the same result as provided by the method getResponsesBySurveyId, but enriched with text analytics data for a subset of responses.
Note: Since the default setting for this parameter is false, you must specify it as “True” in order to see all responses.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId":123,
"allResponses":"false",
"filterXml":"
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>RespondentId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>12345</FilterValue>
</FilterCriteria>
<FilterCriteria>
<FilterColumn>Sentiment</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>",
"xmlIndent":"true"
}
Response Values
GetTextAnalyticsResponsesBySurveyIdResult=[string]
A collection of survey responses with text analytics data in XML representation. GetTextAnalyticsResponsesBySurveyIdResult has the following XML structure:
<Responses>
<Response>
<ResponseId></ResponseId>
<SurveyId></SurveyId>
<RespondentId></RespondentId>
<QuestionId></QuestionId>
<ScaleId></ScaleId>
<AnswerId></AnswerId>
<ResponseText></ResponseText>
<ResponseMemo></ResponseMemo>
<ResponseRank></ResponseRank>
<ResponseState></ResponseState>
<CompletedDate></CompletedDate>
<LanguageId></LanguageId>
<ResponseNum></ResponseNum>
<ResponseDate></ResponseDate>
<TextAnalyticsData>
<TextAnalyticsItem>
<Level1></Level1>
<Level2></Level2>
...
<Level7></Level7>
<Sentiment></Sentiment>
</TextAnalyticsItem>
...
</TextAnalyticsData>
</Response>
<Response>
...
</Response>
...
</Responses>
Here are definitions for the XML fields:
- ResponseId – Identifier of a response; within the return XML there may be one or more responses.
- SurveyId – Identifier of the survey that the response belongs to.
- RespondentId – Identifier of the respondent associated with the response.
- QuestionId – Identifier of the question answered in the response. For a readout of the survey’s questions, issue the call getQuestionsBySurveyId.
- ScaleId – Identifier of the answer group associated with the question. For a readout of the survey’s scales, issue the call getScalesBySurveyId. Scales identify various answer groups for a given question. Every question has at least one scale, but only table questions can have multiple answer groups (scales).
- AnswerId – Identifier of an answer. For a readout of the survey’s answers, issue the call getAnswersBySurveyId. Multiple respondents may have answered a question the same way. In that case multiple respondents may have the same AnswerId in their corresponding response records.
- ResponseText – The text that is entered by a survey respondent to a Short, Numeric, or Date Textbox type question. Empty for other question types.
- ResponseMemo – The text that is entered by a survey respondent to a Long Textbox type question. Empty for other question types.
- ResponseRank – The score chosen by a survey respondent to a rank-type question. The value of the ResponseRank reflects the ordinal position of the answer. Zero for other question types.
- ResponseState – Status of the survey response; Collected = 0, In progress = 2, Abandoned = 3.
- ResponseDate – The date that is entered by a survey respondent to a Date Textbox type question (same as Response.ResponseText, converted to a DateTime data type). Empty for other question types.
- LanguageId – Identifier of the language the survey was delivered in for the respondent. For a readout of the survey’s languages, issue the call getLanguagesBySurveyId.
- ResponseNum – The number that is entered by a survey respondent to a Numeric Textbox type question (same as Response.ResponseText, converted to an integer data type). Zero for other question types.
- CompletedDate – Date on which the survey was completed.
- TextAnalyticsData – Holds a list of text analytics items, will be omitted for responses without text analytics data.
- TextAnalyticsItem – Contains the data for one main text category.
- Level1 – The main text category name.
- Level2,…,Level7 – Detail categories (omitted if empty).
- Sentiment – The categorization’s sentiment (values: -1 = negative, 0 = neutral or 1 = positive).
Notes: 1. All date values are returned in ISO 8601 date format: yyyy-MM-ddTHH:mm:ssZ. 2. All date values are returned in UTC time zone. 3. The getTextAnalyticsResponsesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getTextAnalyticsResponsesBySurveyIdResult"].ToString();
Sample Response
{
“GetTextAnalyticsResponsesBySurveyIdResult”:”<Responses>
<Response>
<ResponseId>27155</ResponseId>
<SurveyId>38</SurveyId>
<RespondentId>2186</RespondentId>
<QuestionId>367</QuestionId>
<ScaleId>387</ScaleId>
<AnswerId>3126</AnswerId>
<ResponseText>I had a really delightful time.</ResponseText>
<ResponseMemo>The server was so sweet, and then he offered to pay off my mortgage!</ResponseMemo>
<ResponseRank>0</ResponseRank>
<ResponseState>0</ResponseState>
<CompletedDate>2015-12-04T03:22:34Z</CompletedDate>
<LanguageId>51</LanguageId>
<ResponseNum>0</ResponseNum>
<ResponseDate />
<TextAnalyticsData>
<TextAnalyticsItem>
<Level1>Text Analytics Level 1</Level1>
<Level2>Text Analytics Level 2</Level2>
<Level3>Text Analytics Level 3</Level3>
<Sentiment>1</Sentiment>
</TextAnalyticsItem>
<TextAnalyticsItem>
<Level1>Text Analytics Level 1</Level1>
<Level2>Text Analytics Level 2</Level2>
<Sentiment>0</Sentiment>
</TextAnalyticsItem>
</TextAnalyticsData>
</Response>
<Response>
<ResponseId>27156</ResponseId>
<SurveyId>38</SurveyId>
<RespondentId>2187</RespondentId>
<QuestionId>367</QuestionId>
<ScaleId>387</ScaleId>
<AnswerId>3126</AnswerId>
<ResponseText>You are all going to pay for this, if it's the last thing I ever do.</ResponseText>
<ResponseMemo>I have never been so insulted in all my life, and furthermore, the salad gave me food poisoning.</ResponseMemo>
<ResponseRank>0</ResponseRank>
<ResponseState>0</ResponseState>
<CompletedDate>2015-12-04T03:26:00Z</CompletedDate>
<LanguageId>51</LanguageId>
<ResponseNum>0</ResponseNum>
<ResponseDate />
<TextAnalyticsData>
<TextAnalyticsItem>
<Level1>Text Analytics Level 1</Level1>
<Level2>Text Analytics Level 2</Level2>
<Sentiment>-1</Sentiment>
</TextAnalyticsItem>
</TextAnalyticsData>
</Response>
</Responses>”
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 123, \
"allResponses": true, \
"filterXml": "
<FilterDefinition>
<FilterGroup GroupOperator='AND'>
<FilterCriteria>
<FilterColumn>RespondentId</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>12345</FilterValue>
</FilterCriteria>
<FilterCriteria>
<FilterColumn>Sentiment</FilterColumn>
<FilterOperator>Equals</FilterOperator>
<FilterValue>1</FilterValue>
</FilterCriteria>
</FilterGroup>
</FilterDefinition>", \
"xmlIndent": true \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/getTextAnalyticsResponsesBySurveyId'
Notes
- The endpoint getTextAnalyticsResponsesBySurveyId shares an export limitation with endpoint getResponsesBySurveyId. The default limit is defined as 50,000 responses per hour (regardless which of these methods is used), where one response means the set of answers a respondent has given to complete a survey (i.e. all the answers contained in one survey response).
-
The getTextAnalyticsResponsesBySurveyId response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json LibraryJObject jsonObject = JObject.Parse(rawResponse);var validXmlString = jsonObject["getTextAnalyticsResponsesBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getTextAnalyticsResponsesBySurveyIdResult"].ToString();// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["getTextAnalyticsResponsesBySurveyIdResult"].ToString();
POST insertInvitationSchedule
Inserts an invitation schedule for a survey into the database.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Id of the survey the invitations should be scheduled for. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
sampleIds=[string] Required
The id of the email list that the invitations should be scheduled for.
templateIds=[string] Required
Comma-separated list of invitation template ids which should be used to create the invitation schedule. This is a comma-separated list because there could be multiple templates per invitation if there is more than one language. Invitations require one template per language. The API uses the default invitation template if there is no template specified for a language in the invitation schedule.
Note: It is best to create these templates in the UI, then use getSurveyInvitationTemplates to gather the templateIDs for the specific survey, then feed these IDs into insertInvitationSchedule.
startTime=[string] Required
Start date and time for sending the invitations, or “now” to send the invitations immediately.
Note: Valid formats for “startTime” depend on the “startTimeCulture”. Cultures are strings containing a language and locale id, like “en-US”, “fr-FR”, “de-DE” and so on. For “en-US” the start time can be entered as usual, like “8/4/2017 09:30AM”.
startTimeZoneId=[string] Optional
The Microsoft Time Zone Index value linked with the startTime (e.g. “GMT” or “Central Standard Time”). If left empty, the API user’s time zone will be used.
startTimeCulture=[string] Optional
The RFC 4545 standard for culture codes (e.g. “en-US”, “fr-FR”, “de-DE”), used to parse the startTime string (if empty the default user culture code is used).
questionIdCc=[int] Optional
Id of the “CC” prepop question (default 0).
questionIdBcc=[int] Optional
Id of the “BCC” prepop question (default 0).
Note: If you want to send (blind) copies of your invitation/reminder mails to other persons you can define hidden questions in your survey (one for CC, one for BCC) and pre-populate them with the respective email addresses. In this case you must pass the question id (a single integer number that can be retrieved by the API method “GetQuestionsBySurveyId”) for the CC and/or BCC question to the API method.
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"surveyId":1,
"sampleIds":1,2,
"templateIds":2,
"startTime":"10/4/2019 11:20AM",
"startTimeZoneId":"Central Standard Time",
"startTimeCulture":"en-US",
"questionIdCc":0,
"questionIdBcc":0
}
Response Values
InsertInvitationScheduleResult=[string]
“OK” if the request was processed successfully, otherwise an appropriate error message.
Sample Response
{
"InsertInvitationScheduleResult":"OK"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"surveyId": 1, \
"sampleIds": 1, 2, \
"templateIds": 2, \
"startTime": "10/4/2019 11:20AM", \
"startTimeZoneId": "Central Standard Time", \
"startTimeCulture": "en-US", \
"questionIdCc": 0, \
"questionIdBcc": 0 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/insertInvitationSchedule'
Notes
POST insertReminderSchedule
Inserts a reminder schedule for a survey into the database.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Id of the survey the reminders should be scheduled for. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
sampleIds=[string] Required
The id of the email list that the reminders should be scheduled for.
templateIds=[string] Required
Comma-separated list of reminder template ids which should be used in the reminder schedule. This is a comma-separated list because there could be multiple templates per reminder if there is more than one language. Reminders require one template per language. The API uses the default reminder template if there is no template specified for a language in the reminder schedule.
Note: It is best to create these templates in the UI, then use getSurveyReminderTemplates to gather the templateIDs for the specific survey, then feed these IDs into insertReminderSchedule.
startTime=[string] Required
Start date and time for sending the invitations, or “now” to send the invitations immediately.
Note: Valid formats for “startTime” depend on the “startTimeCulture”. Cultures are strings containing a language and locale id, like “en-US”, “fr-FR”, “de-DE” and so on. For “en-US” the start time can be entered as usual, like “8/4/2017 09:30AM”.
startTimeZoneId=[string] Optional
The Microsoft Time Zone Index value linked with the startTime (e.g. “GMT” or “Central Standard Time”). If left empty, the API user’s time zone will be used.
startTimeCulture=[string] Optional
The RFC 4545 standard for culture codes (e.g. “en-US”, “fr-FR”, “de-DE”), used to parse the startTime string (if empty the default user culture code is used).
questionIdCc=[int] Optional
Id of the “CC” prepop question (default 0).
questionIdBcc=[int] Optional
Id of the “BCC” prepop question (default 0).
Note: If you want to send (blind) copies of your invitation/reminder mails to other persons you can define hidden questions in your survey (one for CC, one for BCC) and pre-populate them with the respective email addresses. In this case you must pass the question id (a single integer number that can be retrieved by the API method “GetQuestionsBySurveyId”) for the CC and/or BCC question to the API method.
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"surveyId":1,
"sampleIds":1,2,
"templateIds":2,
"startTime":"11/6/2019 09:30AM",
"startTimeZoneId":"Central Standard Time",
"startTimeCulture":"en-US",
"questionIdCc":0,
"questionIdBcc":0
}
Response Values
InsertReminderScheduleResult=[string]
“OK” if the request was processed successfully, otherwise an appropriate error message.
Sample Response
{
"InsertReminderScheduleResult":"OK"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"surveyId": 1, \
"sampleIds": 1, 2, \
"templateIds": 2, \
"startTime": "11/6/2019 09:30AM", \
"startTimeZoneId": "Central Standard Time", \
"startTimeCulture": "en-US", \
"questionIdCc": 0, \
"questionIdBcc": 0 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/insertReminderSchedule'
Notes
POST logout
Signs the user out of the application interface.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
Sample Request
{
"token":"efe7ea29-388c-4f39-8c03-ebb8677722af"
}
Response Values
HTTP status and message
Indication of whether or not logout was successful. Possible values are HTTP Status of 200 or 400 as well as “OK” or error message.
Sample Response
200 OK
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "efe7ea29-388c-4f39-8c03-ebb8677722" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/logout'
Notes
POST newEmailListV2
Initiates the creation of an email list. Note that the email list is created asynchronously, after the method returns. This endpoint will return a DataImportId, which can be used to query the status of the asynchronous import, using the endpoint getEmailListImportStatus.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
emailListFile=[unsigned byte array] Required
Character-delimited text file, with byte order mark, that contains the invitee data.
mappingFile=[unsigned byte array] Required
XML file that defines the following: survey, email list name, email list file delimiter character, duplication rule, notification email addresses, system field mappings, and pre-populated question mappings.
emailListName=[string] Required
Name of the email list. Note that any email list name specified in the mapping file will be ignored if this parameter is not empty.
Sample Request
{
"token":"8544621e-ba51-4db8-bff4-2d5a1e2d9ea3",
"emailListFile": [239, 187, 191, 69, 109, 97, 105, 108, 44, 81, 117, 101, 115, 116, 105, 111, 110, 49, 44, 81, 117, 101, 115, 116, 105, 111, 110, 50, 10, 117, 115, 101, 114, 64, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 44, 65, 44, 66],
"mappingFile":[60, 63, 120, 109, 108, 32, 118, 101, 114, 115, 105, 111, 110, 61, 34, 49, 46, 48, 34, 32, 101, 110, 99, 111, 100, 105, 110, 103, 61, 34, 117, 116, 102, 45, 56, 34, 32, 63, 62, 10, 60, 69, 109, 97, 105, 108, 76, 105, 115, 116, 77, 97, 112, 112, 105, 110, 103, 68, 101, 102, 105, 110, 105, 116, 105, 111, 110, 32, 83, 117, 114, 118, 101, 121, 67, 111, 100, 101, 61, 34, 52, 74, 65, 78, 82, 88, 34, 32, 78, 97, 109, 101, 61, 34, 77, 121, 32, 69, 109, 97, 105, 108, 32, 76, 105, 115, 116, 34, 32, 68, 101, 108, 105, 109, 105, 116, 101, 114, 61, 34, 44, 34, 32, 68, 117, 112, 108, 105, 99, 97, 116, 101, 82, 117, 108, 101, 61, 34, 49, 34, 62, 10, 32, 32, 60, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 101, 115, 62, 10, 32, 32, 32, 32, 60, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 62, 117, 115, 101, 114, 64, 110, 111, 116, 105, 102, 99, 97, 116, 105, 111, 110, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 60, 47, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 62, 10, 32, 32, 60, 47, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 101, 115, 62, 10, 32, 32, 60, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 32, 32, 32, 32, 60, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 32, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 78, 97, 109, 101, 61, 34, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 34, 32, 70, 105, 108, 101, 70, 105, 101, 108, 100, 78, 97, 109, 101, 61, 34, 69, 109, 97, 105, 108, 34, 62, 60, 47, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 32, 32, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 32, 70, 105, 108, 101, 67, 111, 108, 117, 109, 110, 78, 97, 109, 101, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 49, 34, 32, 81, 117, 101, 115, 116, 105, 111, 110, 84, 97, 103, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 95, 79, 110, 101, 34, 62, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 32, 70, 105, 108, 101, 67, 111, 108, 117, 109, 110, 78, 97, 109, 101, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 50, 34, 32, 81, 117, 101, 115, 116, 105, 111, 110, 84, 97, 103, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 95, 84, 119, 111, 34, 62, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 60, 47, 69, 109, 97, 105, 108, 76, 105, 115, 116, 77, 97, 112, 112, 105, 110, 103, 68, 101, 102, 105, 110, 105, 116, 105, 111, 110, 62],
"emailListName":"My First Email List"
}
Response Values
NewEmailListV2Result=[List]
A list of NewEmailListV2Result response objects. Contains the following elements:
- DataImportId – ID of the data import.
- ErrorMessage – Relevant error message if there was an error initiating the email list import.
Sample Response
{
"NewEmailListV2Result":{
"DataImportId":1206,
"ErrorMessage":"Message"
}
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "8544621e-ba51-4db8-bff4-2d5a1e2d9ea3", \
"emailListFile": [239, 187, 191, 69, 109, 97, 105, 108, 44, 81, 117, 101, 115, 116, 105, 111, 110, 49, 44, 81, 117, 101, 115, 116, 105, 111, 110, 50, 10, 117, 115, 101, 114, 64, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 44, 65, 44, 66], \
"mappingFile": [60, 63, 120, 109, 108, 32, 118, 101, 114, 115, 105, 111, 110, 61, 34, 49, 46, 48, 34, 32, 101, 110, 99, 111, 100, 105, 110, 103, 61, 34, 117, 116, 102, 45, 56, 34, 32, 63, 62, 10, 60, 69, 109, 97, 105, 108, 76, 105, 115, 116, 77, 97, 112, 112, 105, 110, 103, 68, 101, 102, 105, 110, 105, 116, 105, 111, 110, 32, 83, 117, 114, 118, 101, 121, 67, 111, 100, 101, 61, 34, 52, 74, 65, 78, 82, 88, 34, 32, 78, 97, 109, 101, 61, 34, 77, 121, 32, 69, 109, 97, 105, 108, 32, 76, 105, 115, 116, 34, 32, 68, 101, 108, 105, 109, 105, 116, 101, 114, 61, 34, 44, 34, 32, 68, 117, 112, 108, 105, 99, 97, 116, 101, 82, 117, 108, 101, 61, 34, 49, 34, 62, 10, 32, 32, 60, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 101, 115, 62, 10, 32, 32, 32, 32, 60, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 62, 117, 115, 101, 114, 64, 110, 111, 116, 105, 102, 99, 97, 116, 105, 111, 110, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 60, 47, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 62, 10, 32, 32, 60, 47, 78, 111, 116, 105, 102, 105, 99, 97, 116, 105, 111, 110, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 101, 115, 62, 10, 32, 32, 60, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 32, 32, 32, 32, 60, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 32, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 78, 97, 109, 101, 61, 34, 69, 109, 97, 105, 108, 65, 100, 100, 114, 101, 115, 115, 34, 32, 70, 105, 108, 101, 70, 105, 101, 108, 100, 78, 97, 109, 101, 61, 34, 69, 109, 97, 105, 108, 34, 62, 60, 47, 83, 121, 115, 116, 101, 109, 70, 105, 101, 108, 100, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 32, 32, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 32, 70, 105, 108, 101, 67, 111, 108, 117, 109, 110, 78, 97, 109, 101, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 49, 34, 32, 81, 117, 101, 115, 116, 105, 111, 110, 84, 97, 103, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 95, 79, 110, 101, 34, 62, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 32, 32, 60, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 32, 70, 105, 108, 101, 67, 111, 108, 117, 109, 110, 78, 97, 109, 101, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 50, 34, 32, 81, 117, 101, 115, 116, 105, 111, 110, 84, 97, 103, 61, 34, 81, 117, 101, 115, 116, 105, 111, 110, 95, 84, 119, 111, 34, 62, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 62, 10, 32, 32, 60, 47, 80, 114, 101, 112, 111, 112, 81, 117, 101, 115, 116, 105, 111, 110, 77, 97, 112, 112, 105, 110, 103, 115, 62, 10, 60, 47, 69, 109, 97, 105, 108, 76, 105, 115, 116, 77, 97, 112, 112, 105, 110, 103, 68, 101, 102, 105, 110, 105, 116, 105, 111, 110, 62], \
"emailListName": "My First Email List" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/newEmailListV2'
Notes
By default, newEmailListV2 enforces the following rate limit:
- You can call the endpoint up to once per minute.
GET ping
Determines whether or not the EmailImport service is responding to requests. Authentication is not required to execute this method.
URL
Parameters
N/A
Sample Request
https://sampleapi.allegiancetech.com/EmailImport.HttpService.svc/web/ping
Response Values
PingResult=[string]
Result of the ping request. Possible values are “OK” for a successful result or otherwise an error response.
Sample Response
{
"PingResult":"OK"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X GET --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/ping'
Notes
POST pingRequiredServices
Tests authentication and communication with the services that the API requires.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9"
}
Response Values
PingRequiredServicesResult=[string]
Result of pingRequiredServices request. Possible values are “OK” for a successful result, otherwise an error response.
Sample Response
{
"PingRequiredServicesResult":"OK"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/pingRequiredServices'
Notes
POST sendInvitationForNewRecipients
Adds new recipients (including optional prepopulated data) to an automatically created email list (one list per day) and schedules an invitation send process. The send process will be scheduled either immediately (default) or on a specific date and time defined per recipient using the “SendDateTime” attribute. You can call the API once per minute with up to 500 invitees per call.
The recipient data must be provided in JSON format.
The EmailAddress attribute is mandatory, all other attributes as well as the prepopulation data are optional. Prepopulation data will be assigned to the survey questions based on their question tag.
The date and time for the SendDateTime attribute is expected to be a UTC date and time.
Note: You must set up the API defaults (fatigue rules, etc.) in the platform for each survey. If you don’t do it and try to use this method, you will receive an error. For instructions on setting these values, see this article in the Knowledge Center. Contact your account representative if you need access to the Knowledge Center.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
The ID of the survey for which new recipients are being added. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
recipients=[string] Required
The data of the new recipients in JSON format. Every recipient contains the following fields:
- EmailAddress – Recipient’s email address; this is required
- FirstName – Recipient’s first name
- LastName – Recipient’s last name
- Language – Recipient’s language; this is required. To determine the languages available to the invitation template, first issue the call getSurveyInvitationTemplates.
- AuthKey – Recipient’s authentication key, if the survey is authenticated (if not provided it will be generated automatically)
- SendDateTime – Date and time when the invitation should be sent, expressed in ISO 8601 format and UTC time zone (if this is not provided the invitation will be sent immediately)
- PrepopData – Prepopulation data associated with the survey, with each data point expressed by the following elements:
- ScaleId – Question scale identifier.
- ScaleTag – Short question scale description.
- QuestionTag – Short question description.
- QuestionScaleId – Question scale identifier; same as ScaleId. To be deprecated.
- Value – Pre-populated text value of the answer.
Determines the handling of duplicate email addresses in the payload (duplicate email addresses in the email list will be handled by fatigue rules).
- 0 – Import the first occurrence of an email address in the payload, ignore later occurrences.
- 1 – Import the last occurrence of an email address in the payload, ignore earlier occurrences.
- 2 – Import all occurrences of an email address.
sampleErrorHandlingRule=[int] Optional
Determines the handling of recipient data errors in the payload.
- 0 – Reject value: Import all data that can be imported. If there is an error in the prepopulation data of a recipient import this recipient with all valid prepopulation values and reject the wrong values only. If a recipient has a wrong email address or an invalid language, reject this recipient completely.
- 1 – Reject row: Reject recipients with any kind of error, import only recipients without any error.
- 2 – Reject payload: Reject the whole payload (import nothing) if an error was found in recipient data.
For any parameter value the method returns messages for all errors found in the payload. These will be returned as warning messages if at least one recipient has been imported or as error messages if no recipient has been imported.
Sample Request
{
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"surveyId": 99,
"recipients": [{
"EmailAddress": "…",
"FirstName": "…",
"LastName": "…",
"Language": "…",
"AuthKey": "…",
"SendDateTime": "yyyy-MM-ddTHH:mm:ssZ",
"PrepopData": [{
"ScaleId": "…",
"Value": "…"
}, {
"ScaleId": "…",
"Value": "…"
}]
},{
"EmailAddress": "…",
"FirstName": "…",
"LastName": "…",
"Language": "…",
"AuthKey": "…",
"SendDateTime": "yyyy-MM-ddTHH:mm:ssZ",
"PrepopData": [{
"QuestionTag": "…",
"Value": "…"
}, {
"QuestionTag": "…",
"Value": "…"
}]
}],
"sampleDeDuplicationRule": 0,
"sampleErrorHandlingRule": 0
}
Response Values
The response depends on whether the new parameter sampleErrorHandlingRule is provided or not. If this parameter is not provided then the response values are the same as before the introduction of the new parameter:
The email list id in case of success, otherwise an error message.
If the new parameter is used the method returns a JSON object containing the email list id and an array of error messages and another array of warning messages:
{
"EmailListId": 999,
"Errors": [],
"Warnings": []
}
If no recipient was imported the “EmaiListId” is zero and the “Errors” array is filled with messages for all errors found in the payload. There are two situations where no recipients can be imported: either the error handling value is 2 (“reject payload”) and at least one error was found or every recipient contains errors, so that even with an error handling value of 0 or 1 nothing could be imported. In the latter case an additional message will be added at the end of the “Errors” array:
"(All recipients rejected)"If at least one recipient has been imported, the “EmailListId” will contain the id of the email list, the recipients will be added, and the messages for all errors found in the payload will be returned in the “Warnings” array.
Usually the error or warning messages start with the email address of the affected recipient followed, by the message related to the particular error, for example:
"<recipient@domain:com> Invalid email address"
Sample Response
Old Version without Error Handling Parameter
{
"SendInvitationForNewRecipientsResult": "100"
}
New Version with Error Handling, No Errors Found
{
"SendInvitationForNewRecipientsResult": "{\"EmailListId\":100,
\"Errors\":[],\"Warnings\":[]}"
}
New Version with Error Handling (Value 0 or 1), Some Errors Found
{
"SendInvitationForNewRecipientsResult": "{\"EmailListId\":100,
\"Errors\":[],\"Warnings\":[\"<recipient11@domain.com>
Question or scale not found. (ScaleId = 999)\",\"<recipient14@domain.com>
Answer not found in scale (ScaleId = 123, PrepopData = yellow)\"]}"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"surveyId": 99, \
"recipients": [ \
{ \
"EmailAddress": "randall.matlock@hotmail.com", \
"FirstName": "Randy", \
"LastName": "Matlock", \
"Language": "English", \
"AuthKey": "HK73", \
"SendDateTime": "2018-05-29T10:23:51Z", \
"PrepopData": [ \
{ \
"ScaleId": "16", \
"ScaleTag": "Scale_13", \
"QuestionTag": "Q_21", \
"QuestionScaleId": "QS_15", \
"Value": "Yes" \
} \
] \
} \
], \
"sampleDeDuplicationRule": "ImportFirstDuplicateEmail", \
"sampleErrorHandlingRule": "RejectValue" \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/sendInvitationForNewRecipients'
Notes
- You can export up to 500 records per minute.
- You can call the endpoint up to once per minute.
POST setOptOuts
Adds opt-out information through bulk insertion.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
xmlRequest=[unsigned byte array] Required
XML document that follows this definition.
Sample Request
The XML file content before conversion to a byte array:
<OptOuts>
<OptOutRecipient>
<OptOutType>Site</OptOutType>
<OptOutEmail>test123.com</OptOutEmail>
<SurveyId>0</SurveyId>
</OptOutRecipient>
<OptOutRecipient>
<OptOutType>Domain</OptOutType>
<OptOutEmail>test-test.com</OptOutEmail>
<SurveyId>0</SurveyId>
</OptOutRecipient>
<OptOutRecipient>
<OptOutType>Survey</OptOutType>
<OptOutEmail>me1984@example.com</OptOutEmail>
<SurveyId>21</SurveyId>
</OptOutRecipient>
<OptOutRecipient>
<OptOutType>Survey</OptOutType>
<OptOutEmail>me1984@example.com</OptOutEmail>
<SurveyId>23</SurveyId>
</OptOutRecipient>
</OptOuts>
The XML file content after conversion to a byte array:
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"xmlRequest": [60,79,112,116,79,117,116,115,62,13,10,32,32,60,79,112,116, …]
}
The request XML contains the following elements:
- OptOutType – Type of email opt-out; one of the following: Survey (the email address is opted out of only the particular survey specified by the surveyId), Site (the email address is opted out of all surveys from your site), Domain (all email addresses from the email domain are opted out of the survey). Note: “Site” in the API is equivalent to “Company” in the GUI.
- OptOutEmail – The email address that is being opted out of further survey invitations.
- SurveyId – The survey for which the email address is being opted out. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
The following rules apply to OptOutType:
- SurveyId is null or 0 and OptOutType is Site => Get all opt outs with a valid email address (e.g. some@one.com, other@mail.com)
- SurveyId is not null or 0 and OptOutType is Survey => Get opt outs for survey with a valid email address (e.g. some@one.com, other@mail.com)
- SurveyId is null or 0 and OptOutType is Domain => Get opt outs with emails, which do not include ‘@’-characters (e.g. some.com, other.com)
Response Values
setOptOutsResult=[string]
An XML file containing the number of successfully added opt-outs and an error list, containing those which could not be added for a specific reason. In case of an invalid XML input file element “NumberOfSuccesfulOptouts” is set to “0” and the element “error” contains the specific error message. The output XML follows this XSD.
Note: The setOptOuts response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["setOptOutsResult"].ToString();
Sample Response
All of your data is succesfully imported:
{
"SetOptOutsResult": "
<OptOutsResults>
<NumberOfSuccesfulOptouts>4</NumberOfSuccesfulOptouts>
</OptOutsResults>"
}
2 of 4 cases are succesfully imported, 2 rejections:
{
"SetOptOutsResult":"
<OptOutsResults>
<NumberOfSuccesfulOptouts>2</NumberOfSuccesfulOptouts>
<RejectedOptOuts>
<RejectedRecipient>
<EmailAddress>test123.com</EmailAddress>
<reason>opted out already exists.</reason>
</RejectedRecipient>
<RejectedRecipient>
<EmailAddress>test-test.com</EmailAddress>
<reason>opted out already exists.</reason>
</RejectedRecipient>
</RejectedOptOuts>
</OptOutsResults>"
}
{
"SetOptOutsResult":"
<OptOutsResults>
<NumberOfSuccesfulOptouts>0</NumberOfSuccesfulOptouts>
<RejectedOptOuts>
<RejectedRecipient>
<EmailAddress>me1984@example.com</EmailAddress>
<reason>skipped already defined for survey id 21</reason>
</RejectedRecipient>
<RejectedRecipient>
<EmailAddress>me1984@example.com</EmailAddress>
<reason>skipped already defined for survey id 23</reason>
</RejectedRecipient>
<RejectedRecipient>
<EmailAddress>test123.com</EmailAddress>
<reason>opted out already exists.</reason>
</RejectedRecipient><RejectedRecipient>
<EmailAddress>test-test.com</EmailAddress>
<reason>opted out already exists.</reason>
</RejectedRecipient>
</RejectedOptOuts>
</OptOutsResults>"
}
If the surveyId is not valid:
{
"SetOptOutsResult":"
<OptOutsResults>
<NumberOfSuccesfulOptouts>0>/NumberOfSuccesfulOptouts>
<RejectedOptOuts>
<RejectedRecipient>
<EmailAddress>me1984@example.com</EmailAddress>
<reason>unkown survey id 12300000</reason>
</RejectedRecipient>
</RejectedOptOuts>
</OptOutsResults>"
}
If the XML file is not valid:
{
"SetOptOutsResult":"
<OptOutsResults>
<NumberOfSuccesfulOptouts>0</NumberOfSuccesfulOptouts>
<error>An error occurred while inserting invitation opt outs XML parsing:
line 20, character 5, illegal qualified name character
</error>
</OptOutsResults>"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"xmlRequest": [60,79,112,116,79,117,116,115,62,13,10,32,32,60,79,112,116, …] \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/setOptOuts'
Notes
-
The survey Id is only populated when the opt out is for a survey, not site-wide; otherwise the survey Id should be “0”. If the XML syntax is not valid, the resulting XML contains the XML element “error” with the detailed information. Otherwise the number of successfully added opt-out addresses are reported in the XML element “NumberOfSuccesfulOptouts”. For each rejected email address an XML element “OptOutRecipient” is added with the rejection reason. An email address rejection can occur for the following reasons:
- If the email address is already marked for site-wide opt-out, opting out the email address will be skipped (whether the opt out type is survey or site). Reason: “opted out already exists”
- If the email address is already setup as a survey opt out, the email address will be skipped. Reason: “skipped already defined for survey id
“ - If a survey Id is given and the “OptOutType” is not equal to “Survey”. Reason: “opt out type is Survey, survey id is not valid”
- If a survey Id is given, but no survey exists with the specific survey Id, the email address is skipped. Reason: “unkown survey id
“
The setOptOuts response contains an XML formatted string. When this response is serialized to JSON for transmission, some XML characters may be escaped using backslash characters. In order to retrieve valid XML from the response, the raw JSON response will need to be first converted to a JSON object. When that happens then the XML string property can be retrieved from the JSON object.
Here is sample C# code that does this:
// Using the Newtonsoft.Json Library JObject jsonObject = JObject.Parse(rawResponse); var validXmlString = jsonObject["setOptOutsResult"].ToString();
POST updateInviteeDemographicAndPrepopData
Updates invitee data (first name, last name, language, email address) and prepopulated questions for the invitees.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
xmlRequest=[unsigned byte array] Required
An XML structure containing the updates (as an unsigned byte array). Example:
<Invitees>
<Invitee SampleDetailId="1" EmailAddress="address1@foo.bar"
Language="English" FirstName="John" LastName="Doe">
<PrepopData QuestionScaleId="11">Yes</PrepopData>
<PrepopData QuestionScaleId="12">No</PrepopData>
<PrepopData QuestionScaleId="13">27</PrepopData>
</Invitee>
<Invitee SampleDetailId="2" Language="German">
<PrepopData QuestionScaleId="11">No</PrepopData>
<PrepopData QuestionScaleId="12">Yes</PrepopData>
<PrepopData QuestionScaleId="13">33</PrepopData>
</Invitee>
<Invitee SampleDetailId="3" EmailAddress="address3@foo.bar"/>
<Invitee SampleDetailId="4" EmailAddress="address4@foo.bar" Language="French">
<PrepopData QuestionScaleId="11">Yes</PrepopData>
<PrepopData QuestionScaleId="12"></PrepopData>
<PrepopData QuestionScaleId="13">77</PrepopData>
</Invitee>
</Invitees>
Sample Request
{
"token":"c3f90919-5b36-4711-b796-782dbd75fe43",
"xmlRequest":[60,73,110,118,105,116,101,101,115,62,13,10,32,32,60,73,110,…]
}
The byte array in the sample request corresponds to the XML example above.
Response Values
UpdateInviteeDemographicAndPrepopDataResult=[string]
An empty string in case of successful execution, otherwise a list of error messages.
Sample Response
{
"UpdateInviteeDemographicAndPrepopDataResult":""
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "c3f90919-5b36-4711-b796-782dbd75fe43", \
"xmlRequest": [60,73,110,118,105,116,101,101,115,62,13,10,32,32,60,73,110,…] \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/updateInviteeDemographicAndPrepopData'
Notes
POST updateInviteeStatus
Activates or deactivates survey invitees.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
surveyId=[int] Required
Specifies the survey for which survey invitees will be activated or deactivated. To find the survey Id, see this Knowledge Center article. For a readout of all surveys the authenticated user has access to, issue the call getSurveyList.
sampleDetailIds=[string] Required
The ids of the sample details to be updated, represented as a comma-separated string.
status=[int] Required
New status to be set. 0 to activate and 1 to deactivate. Taken from the application logic.
Sample Request
{
"token":"e29bc591-e73b-498a-8246-806bb5ec1967",
"surveyId":20,
"sampleDetailIds":19,53,
"status":0
}
Response Values
UpdateInviteeStatusResult=[string]
A service result instance containing the possible errors with the calling parameters; or the status code after the update.
Sample Response
{
"UpdateInviteeStatusResult":"OK"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "e29bc591-e73b-498a-8246-806bb5ec1967", \
"surveyId": 20, \
"sampleDetailIds": 19,53, \
"status": 0 \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/updateInviteeStatus'
Notes
POST validateMappingFile
Does a simple validation of the mapping file.
URL
Parameters
token=[Guid] Required
Authentication token, which is retrieved by calling authenticate.
mappingFile=[unsigned byte array] Required
XML file that defines the following: survey, email list name, email list file delimiter character, duplication rule, notification email addresses, system field mappings, and pre-populated question mappings.
Sample Request
{
"token":"f152254f-eee1-4b37-b18d-07d8ed8dbeb9",
"mappingFile":[
239,
187
]
}
Response Values
ValidateMappingFileResult=[string]
On success, it returns a JSON message that starts with “Success:”; otherwise it returns an error message. A successful message contains the following elements:
- Name – Name of the mapping file.
- SurveyCode – Unique text identification of the survey (e.g. EHJF2K).
- Delimiter – Delimiter character that is used in the email list import file. Must be one of: comma (,), pipe (|), semicolon (;), or tab.
- Rule – Rule governing duplicate email addresses. 0 = Duplicate email addresses will not be imported, 1 = Duplicate email addresses will be imported.
- Email Addresses – Number of email addresses contained in the mapping file.
- System Mappings – Number of system mappings contained in the mapping file.
- Prepop Mappings – Number of question prepopulation mappings contained in the mapping file.
Sample Response
{
"ValidateMappingFileResult":"Success:
Name=listname,
SurveyCode=WGGWBQ,
Delimiter=,,
Rule=0,
Email Addresses=2,
System Mappings=4,
Prepop Mappings=4"
}
Error Response
Error responses are detailed here.
Sample Call
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/xml' -d '{ \
"token": "f152254f-eee1-4b37-b18d-07d8ed8dbeb9", \
"mappingFile": [
239,
187
] \
}' 'https://sampleapi.allegiancetech.com/HttpService.svc/web/validateMappingFile'
Notes
setOptOuts XML Request Document
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="OptOuts"> <xs:complexType> <xs:sequence> <xs:element name="OptOutRecipient" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="OptOutType"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="Survey"/> <xs:enumeration value="Site"/> <xs:enumeration value="Domain"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element type="xs:string" name="OptOutEmail"/> <xs:element type="xs:string" name="SurveyId"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
OptOutsResults XSD
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="OptOutsResults">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:int" name="NumberOfSuccesfulOptouts">
<xs:element type="xs:string" name="error" minOccurs="0" maxOccurs="1">
<xs:element name="OptOutRecipient" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="emailAddress"/>
<xs:element type="xs:string" name="reason"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Sample Email List File
The following is a sample email list file that can be consumed by the MaritzCX Survey Management API:
Email,Question1,Question2
user@domain.com,A,B
Sample Mapping File
The following is a sample mapping file that can be consumed by the MaritzCX Survey Management API:
<?xml version="1.0" encoding="utf-8" ?>
<EmailListMappingDefinition SurveyCode="4JANRX" Name="My Email List" Delimiter="," DuplicateRule="1">
<NotificationEmailAddresses>
<NotificationEmailAddress>user@notifcationdomain.com</NotificationEmailAddress>
</NotificationEmailAddresses>
<SystemFieldMappings>
<SystemFieldMapping SystemFieldName="EmailAddress" FileFieldName="Email"></SystemFieldMapping>
<PrepopQuestionMappings>
<PrepopQuestionMapping FileColumnName="Question1" QuestionTag="Question_One"></PrepopQuestionMapping>
<PrepopQuestionMapping FileColumnName="Question2" QuestionTag="Question_Two"></PrepopQuestionMapping>
</PrepopQuestionMappings>
</EmailListMappingDefinition>
This table explains its various elements:
| Name | Type | Description |
|---|---|---|
| EmailListMappingDefinition | element | Parent element of the mapping definition. |
| SurveyCode | attribute | SurveyCode of the survey associated with the email list. The SurveyCode is displayed as the ‘Survey ID’ on the Manage Survey page. |
| Name | attribute | Name of the email list that will be created. This name will be overridden if a name is provided in the ‘NewEmailList’ api call. |
| Delimiter | attribute | Delimiter character that is used in the email list import file. Must be one of: comma (,), pipe (|), semicolon (;), or tab. |
| DuplicateRule | attribute | 0 = Duplicate email addresses will not be imported, 1 = Duplicate email addresses will be imported. |
| NotificationEmailAddresses | element | Contains a collection of NotificationEmailAddress elements. |
| NotificationEmailAddress | element | Email address that will be sent an email list import status notification. |
| SystemFieldMappings | element | Contains a collection of SystemFieldMapping elements. |
| SystemFieldMapping | element | Contains information on how to map a single column in the email list import file to a single system field. |
| SystemFieldName | attribute | Name of the system field that is being mapped. Valid values are EmailAddress, Language, FirstName, LastName, and AuthenticationKey. |
| FileFieldName | attribute | Name of the email list import file column being mapped. |
| PrepopQuestionMappings | element | Contains a collection of PrepopQuestionMapping elements. |
| PrepopQuestionMapping | element | Contains information on how to map a single column in the email list import file to a single survey question. |
| FileColumnName | attribute | Name of the email list import file column being mapped. |
| QuestionTag | attribute | Question tag of the survey question being mapped. |
Encoding Implementation Examples
The following is a sample Java encoding of the Sample Email List File.
The code can also be found here: https://jdoodle.com/a/Xn4.
public class MCXEncoder {
public static String converStringToUnsignedByteArray(String input) {
byte[] array = input.getBytes();
int[] unsigned_array = new int[array.length];
for (int i = 0; i < array.length; i++) {
unsigned_array[i] = java.lang.Byte.toUnsignedInt(array[i]);
}
StringBuilder sb = new StringBuilder(array.length);
sb.append(unsigned_array[0]);
for (int i = 1; i < unsigned_array.length; i++) {
sb.append(", ").append(unsigned_array[i]);
}
return sb.toString();
}
public static String encodeFile(String mappingFile, boolean addByteOrderMarker) {
String encodedString = converStringToUnsignedByteArray(mappingFile);
return "[" + (addByteOrderMarker ? "239, 187, 191, " + encodedString : encodedString) + "]";
}
public static void main(String args[]) {
String emailListFile = "Email,Question1,Question2\nuser@domain.com,A,B";
System.out.println(MCXEncoder.encodeFile(emailListFile, true));
}
}
Here is its output (with BOM pre-pended):
[239, 187, 191, 69, 109, 97, 105, 108, 44, 81, 117, 101, 115, 116, 105, 111, 110, 49, 44, 81, 117, 101, 115, 116, 105, 111, 110, 50, 10, 117, 115, 101, 114, 64, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 44, 65, 44, 66]
Here is a Bash sample encoding of the Sample Email List File:
echo -n 'Email,Question1,Question2
user@domain.com,A,B' | perl -e 'my $str = do { local $/; <STDIN> };@ascii_character_numbers = unpack("C*", $str);print "@ascii_character_numbers\n";' | sed 's/ /, /g' | sed 's/^/[239, 187, 191, /; s/$/]/'
Here is its output (with BOM pre-pended):
[239, 187, 191, 69, 109, 97, 105, 108, 44, 81, 117, 101, 115, 116, 105, 111, 110, 49, 44, 81, 117, 101, 115, 116, 105, 111, 110, 50, 10, 117, 115, 101, 114, 64, 100, 111, 109, 97, 105, 110, 46, 99, 111, 109, 44, 65, 44, 66]
Error Responses
400 error – “Bad Response”
Something is wrong with one of the parameters you provided.
401 error – “Unauthorized”
Something is wrong with your authentication credentials or token.
403 error – “Forbidden”
Your authentication is correct, but you are not authorized.
429 error – “Rate Exceeded”
You exceeded the allowed usage of a throttled endpoint.
500 error – “Internal Error”
An unexpected error occurred on the server while processing your request.
Response Object – InvitationTemplatesEmailList
InvitationTemplatesEmailList is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| InvitationtemplateId | int | Identifier of the invitation template |
| LanguageId | int | Identifier of the language; for the list of LanguageIds associated with a survey, issue the call getLanguagesBySurveyId. |
| LanguageName | string | Language used for the template; for the list of LanguageNames associated with a survey, issue the call getLanguagesBySurveyId. |
| MessageBody | string | Text of the email template |
| Subject | string | Subject of the email template |
| Description | string | Name of the email template |
| isDefault | boolean | Boolean value that indicates whether or not the template is the default for the survey (either invitation or reminder); possible values are “true” and “false” |
Case Management API
Overview
The Case Management API is composed of a set of ReST endpoints that allow you to perform all aspects of case management – from authentication and logout to viewing and updating case details. Below are the ReST endpoints along with their respective request and response objects, including possible errors.
Permissions
To use the Case Management API, make sure the following is true:
- Case Management is enabled for the company.
- The logged-in user should have access to some cases – the case worker view is all that is exposed.
Getting Started
To connect to the Case Management API, use the following as your base URL:
North America – https://caseapi.allegiancetech.com/CaseManagement.svc
Europe – https://caseapi.mcxplatform.de/CaseManagement.svc
Australia – https://caseapi.mcxplatform.com.au/CaseManagement.svc
HTTP Header Settings
There are 3 HTTP headers that you must set when you request information from the Case Management API:
- Accept = application/json
- Content-Type = application/json
- Accept-Language = [Culture Code]; can be any of the following:
- cs-CZ Ceština (Ceská republika)
- da-DK Danish (Denmark)
- de-AT Deutsch (Österreich)
- de-BE Deutsch (Belgien)
- de-CH Deutsch (Schweiz)
- de-DE German (Germany)
- el-GR Ελληνικά (Ελλάδα)
- en-GB English (United Kingdom)
- en-IE English (Ireland)
- en-US English (United States)
- es-419 Spanish (Latin America)
- es-ES Spanish (Spain, International Sort)
- et-EE Eesti (Eesti)
- fi-FI Suomi (Suomi)
- fr-BE Français (Belgique)
- fr-CA French (Canada)
- fr-CH Français (Suisse)
- fr-FR French (France)
- hi-IN हिन्दी (भारत गणराज्य)
- hr-HR Hrvatski (Hrvatska)
- hu-HU Magyar (Magyarország)
- id-ID Bahasa Indonesia (Indonesia)
- is-IS Íslenska (Ísland)
- it-CH Italiano (Svizzera)
- it-IT Italian (Italy)
- ja-JP 日本語 (日本)
- kk-Cyrl-KZ Қазақша (Қазақстан)
- ko-KR 한국어 (대한민국, 大韓民國)
- lt-LT Lietuviu (Lietuva)
- lv-LV Latviešu (Latvija)
- nl-BE Dutch (België)
- nl-NL Dutch (Netherlands)
- nn-NO Norsk (Norge)
- pl-PL Polski (Polska)
- pt-BR Portuguese (Brazil)
- pt-PT Portuguese (Portugal)
- ro-RO Româna (România)
- ru-RU Русский (Россия)
- sk-SK Slovencina (Slovensko)
- sl-SI Slovenšcina (Slovenija)
- sr-Cyrl-RS српскохрватски (Србија)
- sv-FI Svenska (Finland)
- sv-SE Svenska (Sverige)
- th-TH ภาษาไทย (ประเทศไทย)
- tr-TR Türkçe (Türkiye)
- uk-UA Українська (Україна)
- vi-VN Tiếng Việt (Việt Nam)
- vls-NL West Vlams (Flemish)
- zh-Hans-CN Chinese (Simplified, PRC)
- zh-TW 繁体中文 (中国-台湾)
This value will default to English if it is not supplied. The value specified will also affect the LanguageId (calculated from the culture code) value for endpoints that request data from survey questions and answers. Also note that the way in which time values are formatted (example: DateClosedFormatted) will be affected by this value.
Time Zones
For all parameters and return values, time is accepted and returned in the time zone of the regional URL (see above) that you are logged into:
Adjusted for Daylight Savings Time
- Prod US – (UTC-06:00) Central Time (US & Canada)
- Prod DE – (UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
- Prod AUS – (UTC+10:00) Canberra, Melbourne, Sydney
- Prod NE – (UTC-06:00) Central Time (US & Canada)
Not Adjusted for Daylight Savings Time
- Prod US – (UTC-05:00) Central Time (US & Canada)
- Prod DE – (UTC+00:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
- Prod AUS – (UTC+9:00) Canberra, Melbourne, Sydney
- Prod NE – (UTC-05:00) Central Time (US & Canada)
Parameter Case Sensitivity
It is very important to note that all parameters expected by the Case Management API are case-sensitive; any deviation from the case given in the documentation will produce an error.
POST addWatchers
Adds watchers to a specified list of cases in the Case Management system.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
A list of respondent IDs for which you want to add watchers, composed of integers separated by commas. You can specify up to 2500 respondent IDs in a single call.
caseIds=[string] Required
A list of case IDs for which you want to add watchers, composed of integers separated by commas. You can specify up to 2500 case IDs in a single call.
emailAddresses=[string] Required
A list of email addresses whom you want to make watchers, separated by commas. The email address must be the email address of a MaritzCX platform user. You can specify up to 100 email addresses in a single call.
fullOrLimited=[string] Required
Specifies whether you are adding either a full access or a limited access set of users to the case(s). Possible values are “Full” and “Limited”. If this is anything other than limited, the assumption will be made that the access being added is full access.
Note: All of the parameters are required. token, emailAddresses, and fullOrLimited must be populated. Either caseIds or respondentIds must be populated. If both caseIds and respondentIds are populated, respondentIds take precedence over caseIds. If fullOrLimited is specified as anything other than “limited”, watchers will be added as full access.
Sample Request
{"token": "3d833a36-16d6-42d2-a553-50d8866ab773",
"respondentIds":"18951,18952,18954,19000",
"caseIds":"",
"emailAddresses":"terry.smith@maritzcx.com,john.doe@gmail.com,sally.johnson@maritzcx.com,,dummy,roger@mycomp.com",
"fullOrLimited":"Full"
}
Response Values
AddWatchersResult=[array]
Simple top-level response object returned by this endpoint. Composed of the children caseAddDeleteWatchers and statusMessage.
caseAddDeleteWatchers=[array]
Simple second-level response object returned by this endpoint. Composed of the children CaseID and EmailAddress.
statusMessage=[string]
Value that indicates the result of the Case View update attempt. Possible values are 1) “Successful” – Case View was updated successfully, accompanied by an HTTP status code of 200; and 2) Error Message.
CaseID=[Array of integers]
A comma-separated list of the case IDs that were found in the system and the users added to them as watchers.
EmailAddress=[Array of strings]
A comma-separated list of any email addresses for which there was not a user found in the system.
Sample Response
{
"AddWatchersResult": {
"caseAddDeleteWatchers": {
"CaseID": [
8201,
8202,
8203
],
"EmailAddress": [
"",
"dummy",
"roger@mycomp.com"
]
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid email address request: Missing or empty email addresses."
}
}
There are missing or empty email addresses.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid email address request: There are more than 100 email addresses"
}
}
There are more than 100 email addresses.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: respondentids value is not formatted properly, can only contain integer values separated by commas"
}
}
The respondent IDs are not formatted properly; they can only contain integer values separated by commas.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: respondentids value has more than 2500 numbers in it"
}
}
The respondent IDs value has more than 2500 numbers in it.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: caseids value is not formatted properly, can only contain integer values separated by commas"
}
}
The case ID values are not formatted properly; they can only contain integer values separated by commas.
HTTP Status Code: 400
{
"AddWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: caseids value has more than 2500 numbers in it"
}
}
The case IDs value has more than 2500 numbers in it.
HTTP Status Code: 403
An invalid or expired token was passed in.
HTTP Status Code: 403
The logged-in user doesn’t have case program admin privilege, which is necessary to add watchers.
Sample Call
TBD
Notes
Also, the following limits are enforced:
- You can specify up to 100 email addresses in a single call.
- You can specify up to 2500 respondent IDs in a single call.
- You can specify up to 2500 case IDs in a single call.
POST authenticate
Creates a session token that is used to validate all subsequent requests.
URL
Parameters
userName=[string] Required
Username of the user that will be authenticated.
password=[string] Required
Password of the user that will be authenticated.
companyName=[string] Optional
Identifies the customer. Synonymous with the ‘server configuration profile’ name in the Inquisite Configuration tool. To get this value, see this Knowledge Center article. The MaritzCX Knowledge Center contains comprehensive detail on the tasks you will be performing within the MaritzCX platform. Contact your CX lead if you do not have an account.
Sample Request
{
"userName":"asp@inquisite.com",
"password":"Password1"
}
Response Values
AuthenticateResult=[array]
Complex top-level response object returned by this endpoint. Composed of the child elements listed below:
statusMessage=[string]
Value that indicates the result of the authentication request. Possible values are 1) “Successful” – Authentication worked, accompanied by an HTTP status code of 200; and 2) Error Message.
companies=[array]
Array of child elements that defines a company.
token=[GUID]
A GUID authentication token required by subsequent service calls.
activeCompanyName=[string]
Company that the user was logged into.
activeCompanyProfile=[string]
Active company’s profile name.
token=[GUID]
A GUID authentication token required by subsequent service calls.
activeCompanyId=[int]
The ID of the active company.
programsHaveGoals=[boolean]
True if any of the programs have goals, otherwise false.
sessionTimeout=[date]
Returns the time that the session expires. Presented in Unix date/time format, which is in UTC. The value after it is the timezone. So, for example, given the following time: “sessionTimeout”: “/Date(1564111535227-0600)/”, 1564111535227 is in UTC and -0600 is the timezone.
hasActionPlanFeature=[boolean]
True if the company that the user is logging into has the “Action Plan”(ActionCX) feature enabled. Otherwise false.
hasCaseManagementFeature=[boolean]
True if the company that the user is logging into has the “Case Management” feature enabled. Otherwise false.
currentUserNotificationMode=[int]
Returns the user’s current notification mode. Can be one of the following values: 0 = No Notification; 1 = New Case Status; 2 = New Messages; 3 = Both New Case Status and New Message.
isFranchiseModeEnabled=[boolean]
True if the company has franchise mode enabled, otherwise false.
userId=[GUID]
The GUID that represents the user’s identifier.
Sample Response
{
"AuthenticateResult": {
"activeCompanyId": 10200,
"activeCompanyName": "General Industries",
"activeCompanyProfile": "generalindustries.staging.allegiancetech.com",
"companies": [
{
"Address": {
"AddressLine1": null,
"AddressLine2": null,
"AddressLine3": null,
"City": null,
"PostalCode": null,
"State": null
},
"CompanyDBGroupId": 0,
"CompanyId": 10200,
"CompanyName": "General Industries",
"CompanySettings": null,
"LicenseFeatures": null,
"ParentCompanyId": 0,
"PasswordPolicy": null,
"PhoneNumber": null,
"Selected": false,
"UserCompanySettings": null
}
],
"currentUserNotificationMode": 3,
"hasActionPlanFeature": true,
"hasCaseManagementFeature": true,
"isFranchiseModeEnabled": false,
"programsHaveGoals": true,
"sessionTimeout": "/Date(1563307736037-0500)/",
"statusMessage": "Successful",
"token": "ad57a8e1-9efe-4fcb-beb5-5a0ec4e6002b",
"userId": "74412788-acaa-4926-95ea-24ac7208d7fd"
}
}
Error Response
HTTP Status Code: 401
{
"AuthenticateResult": {
"statusMessage": "Could not validate user: johnque@allegiance.com",
"token": "00000000-0000-0000-0000-000000000000"
}
}
User name and password combination failed validation for the company passed. Retry with valid combination.
HTTP Status Code: 400
{
"AuthenticateResult":{
"statusMessage":"Could not get transport url for company: General Industries",
"token":"00000000-0000-0000-0000-000000000000"
}
}
Company doesn’t exist. Retry with valid company.
HTTP Status Code: 400
{
"AuthenticateResult":{
"statusMessage":"An attempt was made to authenticate an empty username",
"token":"00000000-0000-0000-0000-000000000000"
}
}
User name cannot be blank. Retry with valid User name.
Sample Call
TBD
Notes
POST changeOwners
Changes the owner of a specified list of cases in the Case Management system.
Note: This endpoint will be active and available for use at the following times:
- May 10, 2018 for US
- May 16, 2018 for AU
- May 17, 2018 for EMEA
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
A list of respondent IDs for which you want to change case owners, composed of integers separated by commas. You can specify up to 2500 respondent IDs in a single call.
caseIds=[string] Required
A list of case IDs for which you want to change case owners, composed of integers separated by commas. You can specify up to 2500 case IDs in a single call.
emailAddress=[string] Required
The email address which you want to change the owner to. The email address must be the email address of a MaritzCX platform user. You can specify only 1 email address in a single call.
Note: All of the parameters are required. token and emailAddress must be populated. Either caseIds or respondentIds must be populated. If both caseIds and respondentIds are populated, respondentIds take precedence over caseIds.
Sample Request
{
"token": "ac6ff181-cf4f-4e44-8d69-a6b9a7bfee28",
"respondentIds":"",
"caseIds":"8258,8259,8260,8261,8262,8263",
"emailAddress":"terry.smith@maritzcx.com"
}
Response Values
ChangeOwnersResult=[array]
Simple top-level response object returned by this endpoint. Composed of the children caseChangeOwners and statusMessage.
caseChangeOwners=[array]
Simple second-level response object returned by this endpoint. Composed of the children CaseID and OwnerEmailAddressFound.
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) error message.
OwnerEmailAddressFound=[string]
The result indicating whether or not the emailAddress passed in was a valid user found in the system. It will either be “Owner was found” or “Owner was not found”.
CaseID=[array of integers]
A comma-separated list of the case IDs for which the case owner was changed to the specified user.
Sample Response
{
"ChangeOwnersResult": {
"caseChangeOwners": {
"CaseID": [
8258,
8259,
8260,
8261,
8262,
8263
],
"OwnerEmailAddressFound": "Owner was found"
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid email address request: Missing or empty email address."
}
}
There was a missing or empty email address.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid email address request: There is more than 1 email address"
}
}
There is more than 1 email address.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid respondent ids request: respondentIds value is not formatted properly, can only contain integer values separated by commas"
}
}
The respondent IDs are not formatted properly; they can only contain integer values separated by commas.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid respondent ids request: respondentIds value has more than 2500 numbers in it"
}
}
The respondent IDs value has more than 2500 numbers in it.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid case ids request: caseIds value is not formatted properly, can only contain integer values separated by commas"
}
}
The case ID values are not formatted properly; they can only contain integer values separated by commas.
HTTP Status Code: 400
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Invalid case ids request: caseIds value has more than 2500 numbers in it"
}
}
The case IDs value has more than 2500 numbers in it.
HTTP Status Code: 403
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Error: Not logged in or unauthorized."
}
}
An invalid or expired token was passed in.
HTTP Status Code: 403
{
"ChangeOwnersResult": {
"caseChangeOwners": null,
"statusMessage": "Error: User Doesn't Have Access To Change Owners"
}
}
The logged-in user doesn’t have case program admin privilege, which is necessary to change owners.
Sample Call
TBD
Notes
Also, the following limits are enforced:
- You can specify only 1 email address in a single call.
- You can specify up to 2500 respondent IDs in a single call.
- You can specify up to 2500 case IDs in a single call.
POST deleteCaseActivityNote
Deletes a case activity note.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
activityNoteId=[int] Required
Identifier of the Activity Note to be deleted.
Sample Request
{
"token":"787f5d67-61bf-4645-b448-9eaa670667b7",
"activityNoteId":12
}
Response Values
DeleteCaseActivityNoteResult=[array]
Top-level response object returned by this endpoint, composed of the following child:
statusMessage=[string]
Value that indicates the result of the request to delete a case activity note. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"DeleteCaseActivityNoteResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"deleteCaseActivityNoteResult":{
"statusMessage":"An error occurred logging out.
Error Message:
Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"deleteCaseActivityNoteResult":{
"statusMessage":"An error occurred logging out. Error Message:
Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"deleteCaseActivityNoteResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST deleteWatchers
Deletes watchers from a specified list of cases in the Case Management system.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
A list of respondent IDs for which you want to delete watchers, composed of integers separated by commas. You can specify up to 2500 respondent IDs in a single call.
caseIds=[string] Required
A list of case IDs for which you want to delete watchers, composed of integers separated by commas. You can specify up to 2500 case IDs in a single call.
emailAddresses=[string] Required
A list of email addresses you want to delete as watchers, separated by commas. The email address must belong to a MaritzCX platform user. You can specify up to 100 email addresses in a single call.
fullOrLimited=[string] Required
Specifies whether you are deleting either a full access or a limited access set of users to the case(s). Possible values are “Full” and “Limited”. If this is anything other than limited, the assumption will be made that the watchers being deleted are full access.
Note: All of the parameters are required. token, emailAddresses, and fullOrLimited must be populated. Either caseIds or respondentIds must be populated. If both caseIds and respondentIds are populated, respondentIds take precedence over caseIds. If fullOrLimited is specified as anything other than “limited”, only full access watchers will be deleted (as a safeguard).
Sample Request
{"token": "3d833a36-16d6-42d2-a553-50d8866ab773",
"respondentIds":"18951,18952,18954,19000",
"caseIds":"",
"emailAddresses":"terry.smith@maritzcx.com,john.doe@gmail.com,sally.johnson@maritzcx.com,roger@mycomp.com",
"fullOrLimited":"Full"
}
Response Values
DeleteWatchersResult=[array]
Simple top-level response object returned by this endpoint. Composed of the children caseAddDeleteWatchers and statusMessage.
caseAddDeleteWatchers=[array]
Simple second-level response object returned by this endpoint. Composed of the children CaseID and EmailAddress.
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) error message.
CaseID=[array of integers]
A comma-separated list of the case IDs that were found in the system and the users deleted from them as watchers.
EmailAddress=[array of strings]
A comma-separated list of any email addresses for which no user was found.
Sample Response
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": {
"CaseID": [
8201,
8202,
8203
],
"EmailAddress": [
"",
"dummy",
"roger@mycomp.com"
]
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid email address request: Missing or empty email addresses."
}
}
Missing or empty email addresses.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid email address request: There are more than 100 email addresses"
}
}
There are more than 100 email addresses.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: respondentids value is not formatted properly, can only contain integer values separated by commas"
}
}
Respondent ID is not formatted properly; can only contain integer values separated by commas.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: respondentids value has more than 2500 numbers in it"
}
}
Respondent IDs value has more than 2500 numbers in it.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: caseids value is not formatted properly, can only contain integer values separated by commas"
}
}
Case ID values are not formatted properly; they can only contain integer values separated by commas.
HTTP Status Code: 400
{
"DeleteWatchersResult": {
"caseAddDeleteWatchers": null,
"statusMessage": "Invalid respondent ids request: caseids value has more than 2500 numbers in it"
}
}
The case IDs value has more than 2500 numbers in it.
HTTP Status Code: 403
An invalid or expired token was passed in.
HTTP Status Code: 403
The logged-in user doesn’t have case program admin privilege, which is necessary to delete watchers.
Sample Call
TBD
Notes
Also, the following limits are enforced:
- You can specify up to 100 email addresses in a single call.
- You can specify up to 2500 respondent IDs in a single call.
- You can specify up to 2500 case IDs in a single call.
POST exportBulkCaseData
Retrieves all the cases that are between either the dates or case IDs specified (if both dates and case IDs are specified, the dates will be used).
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseProgramId=[int] Required
The case program identifier. Will default to 0.
beginCaseId=[int] Required
The integer value of the CaseID you want to begin with. Will default to 0.
endCaseId=[int] Required
The integer value of the CaseID you want to end with. Will default to 0.
beginDateSubmitted=[string] Required
The beginning date/time to query for. Will default to an empty string. Example – “01-01-1970 12:00 AM” or “01-01-1970 12:00:00.000” – All queries are performed in the database time zone where the server is located. US Production – Central Time Zone, EMEA – Central European, Australia – Australian Eastern.
endDateSubmitted=[string] Required
The ending date/time to query for. Will default to an empty string. Example – “01-01-1970 12:00 AM” or “01-01-1970 12:00:00.000” – All queries are performed in the database time zone where the server is located. US Production – Central Time Zone, EMEA – Central European, Australia – Australian Eastern.
beginDateModified=[string] Required
The beginning modified date/time of the case to query for. Will default to “01-01-1970 12:00 AM”. Example – “01-01-1970 12:00 AM” or “01-01-1970 12:00:00.000” – All queries are performed in the database time zone where the server is located. US Production – Central Time Zone, EMEA – Central European, Australia – Australian Eastern.
The modified date/time will always be applied to the query for all values. For instance, if you want to send in a list of Respondent IDs or a beginDateSubmitted and in addition only want cases that have been modified since a certain date, this will allow you to accomplish that.
endDateModified=[string] Required
The ending modified date/time of the case to query for. Will default to an empty string. Example – “01-01-1970 12:00 AM” or “01-01-1970 12:00:00.000” – All queries are performed in the database time zone where the server is located. US Production – Central Time Zone, EMEA – Central European, Australia – Australian Eastern.
respondentIds=[string] Required
A comma-separated list of Respondent IDs to query for. Will default to an empty string. Example – “1234,1235,1236,1237,1238,1239,1567,1568,1569”. Only integer values or a comma are allowed in the string. The string must begin and end with an integer value.
Note: If only caseProgramId is passed in, then the export will limit items to only cases belonging to that caseProgramId. If only respondentIds are passed in, then the export will limit items to only cases belonging to those respondentIds. If they are both passed in, then the export will limit items to only cases belonging to that caseProgramId and those respondentIds. The only time respondentIds take precedence over something else is if you pass in respondentIds and a beginDateSubmitted; in that case then the respondentIds will take precedence over the beginDateSubmitted.
Sample Request
{"token": "c3f8d275-dacd-4c5d-abb2-084e0cf57c2f",
"caseProgramId":0,
"beginDateModified":"",
"endDateModified":"",
"beginCaseId":0,
"endCaseId":0,
"beginDateSubmitted":"",
"endDateSubmitted":"",
"respondentIds":""
}
Response Values
ExportBulkCaseDataResult=[array]
Complex top-level response object returned by this endpoint. Composed of the following children:
caseBulkExport=[array]
Complex second-level response object returned by this endpoint.
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"ExportBulkCaseDataResult": {
"caseBulkExport": [
{
"CaseActivityNotes": [
{
"ActivityNote": "Second note",
"ActivityNoteDate": "/Date(1506701967943-0600)/",
"ActivityNoteName": "ACTIVITY NOTES",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
},
{
"ActivityNote": "Third note",
"ActivityNoteDate": "/Date(1506702412417-0600)/",
"ActivityNoteName": "ACTIVITY NOTES",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
}
],
"CaseAlertName": "NPS 0-6",
"CaseClosedDate": "/Date(631177200000-0700)/",
"CaseFormFieldValues": [
{
"CaseFormFieldName": "Additional Dropdown.",
"CaseFormFieldValue": "Dropdown 3",
"ModifiedDate": "/Date(1532107007223-0600)/"
}
],
"CaseID": 7737,
"CaseModifiedDate": "/Date(1514912119267-0700)/",
"CaseOwnerEmail": "phil.harker@yourdomain.com",
"CaseOwnerName": "Phil Harker",
"CasePriority": "High",
"CaseProgramName": "DanO Case Program 1",
"CaseRootCauseValues": [],
"CaseStatus": "In Progress",
"CaseSubmittedDate": "/Date(1494365585963-0600)/",
"CaseTimeOffset": 0,
"CaseTimeToClose": 10926,
"CaseTimeToCloseDays": 0,
"CaseTimeToCloseHours": 3,
"CaseTimeToRespond": 10926,
"CaseTimeToRespondDays": 0,
"CaseTimeToRespondHours": 3,
"CaseWatcherValues": [
{
"AccessDate": "/Date(1532106745127-0600)/",
"AccessFromEmail": "phil.harker@yourdomain.com",
"AccessFromName": "Phil Harker",
"AccessText": "",
"AccessToEmail": "steve.richins@yourdomain.com",
"AccessToName": "Steve Richins",
"AccessType": "Full"
},
{
"AccessDate": "/Date(1532114303490-0600)/",
"AccessFromEmail": "phil.harker@ yourdomain.com",
"AccessFromName": "Phil Harker",
"AccessText": "",
"AccessToEmail": "mark.kolp@yourdomain.com",
"AccessToName": "Mark Kolp",
"AccessType": "Limited"
}
],
"DataReferences": [
{
"Answer": "Bernalillo County",
"DataReferenceLabel": "",
"DataReferenceName": "StateLevel2",
"Question": "State - Level 2"
},
{
"Answer": "New Mexico",
"DataReferenceLabel": "",
"DataReferenceName": "StateTopLevel",
"Question": "State - Top Level"
}
{
"Answer": "LA Watchers List",
"DataReferenceLabel": "",
"DataReferenceName": "LAWatchers",
"Question": "LA Watchers:"
},
{
"Answer": "FA Watchers List",
"DataReferenceLabel": "",
"DataReferenceName": "FAWatchers",
"Question": "FA Watchers:"
},
{
"Answer": "Yes",
"DataReferenceLabel": "",
"DataReferenceName": "Contact&<>You",
"Question": "Contact you:"
},
{
"Answer": "7",
"DataReferenceLabel": "",
"DataReferenceName": "NPSScore",
"Question": "NPS score:"
},
{
"Answer": "email@address.com",
"DataReferenceLabel": "",
"DataReferenceName": "EscalateTo",
"Question": "Escalate to:"
},
{
"Answer": "Doe",
"DataReferenceLabel": "",
"DataReferenceName": "LastName",
"Question": "Last name:"
},
{
"Answer": "John",
"DataReferenceLabel": "",
"DataReferenceName": "FirstName",
"Question": "First name:"
},
{
"Answer": "Other - This is the other text: 1, Rank 2: 2, Rank 1: 3, Rank3: 4",
"DataReferenceLabel": "",
"DataReferenceName": "Rank Question",
"Question": "Rank Question:"
},
{
"Answer": "Button B2",
"DataReferenceLabel": "",
"DataReferenceName": "Buttons, Question",
"Question": "Buttons, choose many, Question:"
},
],
"Escalated": false,
"PriorityValues": [
{
"DateChanged": "/Date(1532107007223-0600)/"
"NewName": "High",
"PreviousName": "None Selected",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
}
],
"RespondentID": 18328,
"StatusValues": [
{
"DateChanged": "/Date(1532107007223-0600)/"
"NewName": "In Progress",
"PreviousName": "New",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
}
],
"SurveyName": "DanO Case Survey 1",
"TimeToCloseGoal": 432000,
"TimeToCloseGoalDays": 5,
"TimeToCloseGoalHours": 0,
"TimeToRespondGoal": 172800,
"TimeToRespondGoalDays": 2,
"TimeToRespondGoalHours": 0
},
{
"CaseActivityNotes": [],
"CaseAlertName": "NPS 0-6",
"CaseClosedDate": "/Date(1496400315223-0600)/",
"CaseFormFieldValues": [
{
"CaseFormFieldName": "RESOLUTION DESCRIPTION",
"CaseFormFieldValue": "res description 2017-06-02",
"ModifiedDate": "/Date(1532107007223-0600)/"
},
{
"CaseFormFieldName": "OUTCOME",
"CaseFormFieldValue": "Resolved",
"ModifiedDate": "/Date(1532107007223-0600)/"
}
],
"CaseID": 7738,
"CaseModifiedDate": "/Date(1514912119267-0700)/",
"CaseOwnerEmail": "phil.harker@yourdomain.com",
"CaseOwnerName": "Phil Harker",
"CasePriority": "Medium",
"CaseProgramName": "DanO Case Program 1",
"CaseRootCauseValues": [
{
"ModifiedDate": "/Date(1532107007223-0600)/",
"RootCauseResource": "ROOT CAUSE",
"RootCauseValue": "Root cause section 1 -> Root cause subsection 1"
}
],
"CaseStatus": "Closed",
"CaseSubmittedDate": "/Date(1494365656577-0600)/",
"CaseTimeOffset": 0,
"CaseTimeToClose": 10926,
"CaseTimeToCloseDays": 0,
"CaseTimeToCloseHours": 3,
"CaseTimeToRespond": 10926,
"CaseTimeToRespondDays": 0,
"CaseTimeToRespondHours": 3,
"CaseWatcherValues": [
{
"AccessDate": "/Date(1532106745127-0600)/",
"AccessFromEmail": "phil.harker@yourdomain.com",
"AccessFromName": "Phil Harker",
"AccessText": "",
"AccessToEmail": "steve.richins@yourdomain.com",
"AccessToName": "Steve Richins",
"AccessType": "Full"
},
{
"AccessDate": "/Date(1532114303490-0600)/",
"AccessFromEmail": "phil.harker@ yourdomain.com",
"AccessFromName": "Phil Harker",
"AccessText": "",
"AccessToEmail": "mark.kolp@yourdomain.com",
"AccessToName": "Mark Kolp",
"AccessType": "Limited"
}
],
"DataReferences": [
{
"Answer": "Checkbox 1b, Other: This is the checkbox other",
"DataReferenceLabel": "",
"DataReferenceName": "Checkbox, cm, Other",
"Question": "Checkbox, choose many, Question with Other"
},
{
"Answer": "Star 1",
"DataReferenceLabel": "",
"DataReferenceName": "Stars Question",
"Question": "Stars Question:"
},
{
"Answer": "9/26/2019",
"DataReferenceLabel": "",
"DataReferenceName": "Date Question",
"Question": "Date Question:"
},
{
"Answer": "2.34567",
"DataReferenceLabel": "",
"DataReferenceName": "Numeric Question",
"Question": "Numeric Question:"
},
{
"Answer": "Phoenix",
"DataReferenceLabel": "",
"DataReferenceName": "WhichArea",
"Question": "Which area:"
}
],
"Escalated": false,
"PriorityValues": [
{
"DateChanged": "/Date(1532107007223-0600)/"
"NewName": "Medium",
"PreviousName": "None Selected",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
}
],
"RespondentID": 18330,
"StatusValues": [
{
"DateChanged": "/Date(1522107007223-0600)/"
"NewName": " In Progress",
"PreviousName": "New",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
},
{
"DateChanged": "/Date(1532107007223-0600)/"
"NewName": "Closed",
"PreviousName": "In Progress",
"UserEmail": "steve.richins@yourdomain.com",
"UserName": "Steve Richins"
}
],
"SurveyName": "DanO Case Survey 1",
"TimeToCloseGoal": 432000,
"TimeToCloseGoalDays": 5,
"TimeToCloseGoalHours": 0,
"TimeToRespondGoal": 172800,
"TimeToRespondGoalDays": 2,
"TimeToRespondGoalHours": 0
}
],
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"ExportBulkCaseDataResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"ExportBulkCaseDataResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "caseProgramId must be greater than 0"
}
}
An invalid case program ID was passed in.
HTTP Status Code: 400
{
"ExportBulkCaseDataResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "startDate Cannot be greater than endDate"
}
}
Invalid start/end dates were passed in.
HTTP Status Code: 403
{
"ExportBulkCaseDataResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "Error: Not logged in or unauthorized."
}
}
An invalid or expired token was passed in.
HTTP Status Code: 403
{
"ExportBulkCaseDataResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "User Doesn't Have Access To Export"
}
}
The logged-in user doesn’t have case program admin privilege, which is necessary to do exports.
HTTP Status Code: 400
{
"ExportBulkCaseDataResult": {
"caseBulkExport": null,
"statusMessage": "Invalid date request: startDate Cannot be greater than endDate"
}
}
The endDateSubmitted is greater than beginDateSubmitted.
HTTP Status Code: 400
{
"ExportBulkCaseDataResult": {
"caseBulkExport": null,
"statusMessage": "Invalid date request: String was not recognized as a valid DateTime."
}
}
The string is not recognized as a date.
Sample Call
TBD
Notes
POST exportCasesByCaseProgramId
Returns the list of cases associated with the case program identifier that have been modified within the specified dates.
Note: The logged-in user must have case program admin privilege in order to use this endpoint.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseProgramId=[int] Required
The case program identifier.
startDate=[time in UNIX format] Required
The starting date and time to look for modified cases.
endDate=[time in UNIX format] Required
The ending date and time to look for modified cases.
Sample Request
{"token": "b8f7cb1b-3af0-47b6-a16f-334c6bba9af4",
"caseProgramId":4,
"startDate":"/Date(1493611200000-0500)/",
"endDate": "/Date(1493758518318-0500)/"
}
Response Values
ExportCasesByCaseProgramIDResult=[array]
Complex top-level response object returned by this endpoint. Composed of the following children:
CaseExportViewValues=[array]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
CaseFormSettings=[string]
This used to represent the case form with all controls; it was kept for backward compatibility but will always be null.
CaseProgramId=[int]
The case program identifier.
NumberOfCasesModified=[int]
Number of cases in the return set that have been modified.
respondentIdsNotCases=[string]
Will be a blank string for ExportCasesByCaseProgramID.
CaseViewSettings=[array]
This is the same as the CaseView object. It differs from other instances of it in that it will only appear one time because it applies to all cases, and thus the caseID will be zero.
CaseCanvasSettings=[string]
This is a long JSON string with the specific case form dimensions and other related information.
Sample Response
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": [
{
"CaseExportViewValues": [
{
"ActivityNotes": [
{
"ActivityNote": "This is a note!",
"ActivityNoteDate": "/Date(1494880437010-0600)/",
"ActivityNoteDateFormatted": "2017-05-15T14:33:57.010-06:00",
"CaseActivityNoteId": 228,
"CaseId": 7747,
"FirstName": "Mark",
"FullName": "Mark Smith",
"HashCode": "0EBA6225C0F00A3ABE777797B61AE1CB7CD9D57B",
"LastName": "Smith",
"NoteFile": null,
"UserId": "861728bb-b83e-4946-ac14-0055b610c2f9"
}
],
"AlertName": "Alert 1 - DEV",
"CaseId": 7747,
"CasePriorityTypeId": 0,
"CaseRootCauseAnswers": [],
"CaseRootCauseTreeIds": [],
"CaseStatusTypeId": 3,
"CaseTriggerId": 301,
"CaseWatchers": [
{
"Access": 1,
"Email": "steve.smith@maritzcx.com",
"Id": "02198098-8844-441b-8e18-081d57e87194",
"Name": "Steve Smith"
}
],
"CurrentUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"DateClosed": "/Date(1494880528940-0600)/",
"DateClosedFormatted": "2017-05-15T14:35:28.940-06:00",
"DateSubmitted": "/Date(1494527490803-0600)/",
"DateSubmittedFormatted": "2017-05-11T12:31:30.803-06:00",
"DisableCaseReassignmentNotifications": false,
"DisableCaseWatcherNotifications": false,
"FirstName": "Mark",
"ItemAnswers": [],
"LastName": "Smith",
"ModifiedDate": "/Date(1527279871763-0600)/",
"ModifiedDateFormatted": "2018-05-25T14:24:31.763-06:00",
"OwnerEmail": "mark.Smith@maritzcx.com",
"OwnerFullName": "Mark Smith",
"OwnerUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"ProgramName": "mlk Program 1'ab",
"RespondentHash": null,
"RespondentId": 18340,
"SourceName": "",
"SourceResponses": [
{
"Key": -280,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "How did you originally become aware of the Dräger training?",
"ScaleId": 280
}
},
{
"Key": -1034,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 5857,
"AnswerIds": [
5857
],
"AnswerText": "Probably Not",
"DisplayType": 0,
"QuestionText": "NPS Question ",
"ScaleId": 1034
}
},
{
"Key": -1053,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "First Name",
"ScaleId": 1053
}
},
{
"Key": -1131,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "Franchise ID:",
"ScaleId": 1131
}
},
{
"Key": -1591,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "new Tac",
"ScaleId": 1591
}
}
],
"SourceValues": [
{
"Key": "item_-280",
"Value": "How did you originally become aware of the Dräger training?"
},
{
"Key": "item_-1034",
"Value": "NPS Question "
},
{
"Key": "item_-1053",
"Value": "First Name"
},
{
"Key": "item_-1131",
"Value": "Franchise ID:"
},
{
"Key": "item_-1591",
"Value": "new Tac"
}
],
"SurveyId": 79,
"SurveyName": "mlk Survey 1",
"SurveyResponseDate": "/Date(1494527458000-0600)/",
"SurveyResponseDateFormatted": "2017-05-11T12:30:58.000-06:00",
"TimeToClose": 353038,
"TimeToCloseColor": 1,
"TimeToCloseDays": 4,
"TimeToCloseDisplay": "4d 2h",
"TimeToCloseGoal": 14400,
"TimeToCloseGoalDays": 0,
"TimeToCloseGoalDisplay": "0d 4h",
"TimeToCloseGoalHours": 4,
"TimeToCloseHours": 2,
"TimeToRespond": 352947,
"TimeToRespondColor": 1,
"TimeToRespondDays": 4,
"TimeToRespondDisplay": "4d 2h",
"TimeToRespondGoal": 7200,
"TimeToRespondGoalDays": 0,
"TimeToRespondGoalDisplay": "0d 2h",
"TimeToRespondGoalHours": 2,
"TimeToRespondHours": 2,
"WatcherType": 0
}
],
"CaseFormSettings": null,
"CaseProgramId": 82,
"CaseViewSettings": {
"CaseCanvasSettings": "{\"height\":\"11in\",\"width\":\"754px\",\"showGrid\":true,\"showPageBreaks\":false,\"paperSize\":\"letter\"}",
"CaseStatusIds": [
1,
2,
3
],
"CaseViewItems": [
{
"CaseId": 0,
"CaseItemId": 2997,
"CaseItemText": "",
"CaseProgramId": 82,
"CaseQuestionTypeId": 18,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":60,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":0,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2997",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 0,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 2998,
"CaseItemText": "",
"CaseProgramId": 82,
"CaseQuestionTypeId": 19,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":360,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":1,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2998",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 1,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 2999,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":180,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":2,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2999",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 2,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3000,
"CaseItemText": "I&D:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 1,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"I&D:\",\"required\":\"\",\"top\":240,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":3,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":null,\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":null,\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3000",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 3,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3001,
"CaseItemText": "CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 3,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CREATED:\",\"required\":\"\",\"top\":300,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":4,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3001",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 4,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3002,
"CaseItemText": "CLOSED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 16,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CLOSED:\",\"required\":\"\",\"top\":360,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":5,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3002",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 5,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3003,
"CaseItemText": "OWNER",
"CaseProgramId": 82,
"CaseQuestionTypeId": 9,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OWNER\",\"required\":\"\",\"top\":420,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":6,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3003",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 6,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3004,
"CaseItemText": "PRIORITY",
"CaseProgramId": 82,
"CaseQuestionTypeId": 5,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3004,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1034,
"Operator": 4,
"SourceId": 79,
"Values": [
"5856",
"5857"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink666",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget666",
"RootCauseTreeIdNodes": [],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [
{
"Id": 0,
"LocalizedLabel": "shared.noneSelected",
"Text": null
},
{
"Id": 1,
"LocalizedLabel": "shared.high",
"Text": null
},
{
"Id": 2,
"LocalizedLabel": "shared.medium",
"Text": null
},
{
"Id": 3,
"LocalizedLabel": "shared.low",
"Text": null
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"PRIORITY\",\"required\":\"\",\"top\":510,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":7,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3004",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 7,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3005,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":180,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":8,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3005",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 8,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3006,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Ainformation%20such%20as%20customer%20name%20and%20contact%20details%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":240,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Ainformation%20such%20as%20customer%20name%20and%20contact%20details%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":9,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3006",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 9,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3007,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ERESPONSE%20SUMMARY%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":360,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ERESPONSE%20SUMMARY%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":10,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3007",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 10,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3008,
"CaseItemText": "SURVEY TAKEN:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 17,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"SURVEY TAKEN:\",\"required\":\"\",\"top\":420,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":11,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3008",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 11,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3009,
"CaseItemText": "ALERT CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 10,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ALERT CREATED:\",\"required\":\"\",\"top\":480,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":12,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3009",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 12,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3010,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Arelevant%20survey%20response%20excerpts%20such%20as%20overall%20satisfaction%20or%3Cbr%20%2F%3E%0Alikelihood%20to%20recommend%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":540,\"left\":390,\"width\":360,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Arelevant%20survey%20response%20excerpts%20such%20as%20overall%20satisfaction%20or%3Cbr%20%2F%3E%0Alikelihood%20to%20recommend%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":13,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3010",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 13,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3011,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20ACTIVITY%20AND%20RESOLUTION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":780,\"left\":30,\"width\":630,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20ACTIVITY%20AND%20RESOLUTION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":14,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3011",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 14,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3012,
"CaseItemText": "CASE STATUS",
"CaseProgramId": 82,
"CaseQuestionTypeId": 4,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": 1,
"LocalizedLabel": "shared.new",
"Text": null
},
{
"Id": 2,
"LocalizedLabel": "shared.inProgress",
"Text": null
},
{
"Id": 3,
"LocalizedLabel": "shared.closed",
"Text": null
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CASE STATUS\",\"required\":\"\",\"top\":840,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":15,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3012",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 15,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3013,
"CaseItemText": "OUTCOME",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3013,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1034,
"Operator": 4,
"SourceId": 79,
"Values": [
"5858",
"5859"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink667",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget667",
"RootCauseTreeIdNodes": [],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [
{
"Id": 651,
"LocalizedLabel": null,
"Text": "Resolved"
},
{
"Id": 652,
"LocalizedLabel": null,
"Text": "Unable to contact"
},
{
"Id": 653,
"LocalizedLabel": null,
"Text": "Unresolved"
},
{
"Id": 654,
"LocalizedLabel": null,
"Text": "Other"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OUTCOME\",\"required\":\"required\",\"top\":930,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":16,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3013",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 16,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3014,
"CaseItemText": "RESOLUTION DESCRIPTION",
"CaseProgramId": 82,
"CaseQuestionTypeId": 12,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"RESOLUTION DESCRIPTION\",\"required\":\"required\",\"top\":1410,\"left\":30,\"width\":330,\"height\":180,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":17,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3014",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 17,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3015,
"CaseItemText": "ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3015,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1591,
"Operator": 4,
"SourceId": 79,
"Values": [
"9684",
"9685"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink665",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget665",
"RootCauseTreeIdNodes": [
"j7_1",
"j7_3",
"j7_4"
],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ROOT CAUSE\",\"required\":\"required\",\"top\":840,\"left\":390,\"width\":360,\"height\":240,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3015",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6348,
"ParentTreeId": "#",
"RootCauseName": "Root Cause2 & Section 1",
"SortPosition": 0,
"TreeId": "j7_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6669,
"ParentTreeId": "j7_1",
"RootCauseName": "A child 1",
"SortPosition": 1,
"TreeId": "j8_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6670,
"ParentTreeId": "j8_1",
"RootCauseName": "a sub child",
"SortPosition": 2,
"TreeId": "j8_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6351,
"ParentTreeId": "#",
"RootCauseName": "Root cause2 section 2",
"SortPosition": 3,
"TreeId": "j7_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6663,
"ParentTreeId": "j7_2",
"RootCauseName": "1",
"SortPosition": 4,
"TreeId": "j8_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6664,
"ParentTreeId": "j7_2",
"RootCauseName": "2",
"SortPosition": 5,
"TreeId": "j8_4"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6665,
"ParentTreeId": "j7_2",
"RootCauseName": "3",
"SortPosition": 6,
"TreeId": "j8_5"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6666,
"ParentTreeId": "j7_2",
"RootCauseName": "4",
"SortPosition": 7,
"TreeId": "j8_6"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6667,
"ParentTreeId": "j7_2",
"RootCauseName": "5",
"SortPosition": 8,
"TreeId": "j8_7"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6668,
"ParentTreeId": "j7_2",
"RootCauseName": "New node",
"SortPosition": 9,
"TreeId": "j8_8"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6540,
"ParentTreeId": "#",
"RootCauseName": "New root",
"SortPosition": 10,
"TreeId": "j3_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6561,
"ParentTreeId": "#",
"RootCauseName": "Another Node",
"SortPosition": 11,
"TreeId": "j21_1"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3016,
"CaseItemText": "%3Cp%3E%3Cem%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3EEnter%20an%20activity%20note%20each%20time%20you%20work%20the%20case%20that%20describes%20the%20action%20taken.%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fem%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":1230,\"left\":30,\"width\":720,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cem%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3EEnter%20an%20activity%20note%20each%20time%20you%20work%20the%20case%20that%20describes%20the%20action%20taken.%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fem%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":19,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3016",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 19,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3017,
"CaseItemText": "ACTIVITY NOTES",
"CaseProgramId": 82,
"CaseQuestionTypeId": 7,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ACTIVITY NOTES\",\"required\":\"\",\"top\":1260,\"left\":30,\"width\":720,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":20,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3017",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 20,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3172,
"CaseItemText": "View/Add Watchers:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 22,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#8cc652\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"View/Add Watchers:\",\"required\":\"\",\"top\":630,\"left\":30,\"width\":300,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":22,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3172",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 22,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3294,
"CaseItemText": "Case Program Name:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 2,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Case Program Name:\",\"required\":\"\",\"top\":690,\"left\":30,\"width\":300,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":23,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3294",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 23,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3447,
"CaseItemText": "Dropdown 2",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": 798,
"LocalizedLabel": null,
"Text": "red"
},
{
"Id": 799,
"LocalizedLabel": null,
"Text": "blue"
},
{
"Id": 800,
"LocalizedLabel": null,
"Text": "white"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Dropdown 2\",\"required\":\"\",\"top\":1050,\"left\":30,\"width\":120,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":24,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3447",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 24,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3535,
"CaseItemText": "Date Picker",
"CaseProgramId": 82,
"CaseQuestionTypeId": 26,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Date Picker\",\"required\":\"\",\"top\":1140,\"left\":390,\"width\":390,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":25,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":true,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3535",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 25,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3716,
"CaseItemText": "Color ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Color ROOT CAUSE\",\"required\":\"required\",\"top\":1110,\"left\":0,\"width\":390,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3716",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6578,
"ParentTreeId": "#",
"RootCauseName": "Colors",
"SortPosition": 0,
"TreeId": "j11_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6579,
"ParentTreeId": "j11_1",
"RootCauseName": "Red",
"SortPosition": 1,
"TreeId": "j11_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6580,
"ParentTreeId": "j11_1",
"RootCauseName": "Green",
"SortPosition": 2,
"TreeId": "j11_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6581,
"ParentTreeId": "j11_1",
"RootCauseName": "Blue",
"SortPosition": 3,
"TreeId": "j11_4"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
}
],
"ClosingStatusIds": [
3
],
"IsActionPlan": false,
"NewStatusId": 1
},
"NumberOfCasesModified": 1
}
],
"respondentIdsNotCases": null,
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "caseProgramId must be greater than 0"
}
}
An invalid case program ID was passed in.
HTTP Status Code: 400
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "startDate Cannot be greater than endDate"
}
}
Invalid start/end dates were passed in.
HTTP Status Code: 403
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "Error: Not logged in or unauthorized."
}
}
An invalid or expired token was passed in.
HTTP Status Code: 403
{
"ExportCasesByCaseProgramIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "User Doesn't Have Access To Export"
}
}
The logged-in user doesn’t have case program admin privilege, which is necessary to do exports.
Sample Call
TBD
Notes
POST exportCasesByRespondentID
Returns the list of cases associated with the case program identifier that have been modified within the specified dates.
Note: The logged-in user must have case program admin privilege in order to use this endpoint.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
Comma-delimited list of respondent identifiers.
Sample Request
{"token": "4fc9d727-71b8-44c6-835f-386f3b5614b1",
"respondentIds":"1,2165,23490,3915208,18,27,28,2052"
}
Response Values
ExportCasesByRespondentIDResult=[array]
Complex top-level response object returned by this endpoint. Composed of the following children:
CaseExportViewValues=[array]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
CaseFormSettings=[string]
This used to represent the case form with all controls; it was kept for backward compatibility but will always be null.
CaseProgramId=[int]
The case program identifier.
NumberOfCasesModified=[int]
Number of cases in the return set that have been modified.
respondentIdsNotCases=[string]
List of respondents passed that did not have cases associated with them.
CaseViewSettings=[array]
This is the same as the CaseView object. It differs from other instances of it in that it will only appear one time because it applies to all cases, and thus the caseID will be zero.
CaseCanvasSettings=[string]
This is a long JSON string with the specific case form dimensions and other related information.
Sample Response
{
"ExportCasesByRespondentIDResult": {
"caseExport": [
{
"CaseExportViewValues": [
{
"ActivityNotes": [
{
"ActivityNote": "This is a note!",
"ActivityNoteDate": "/Date(1494880437010-0600)/",
"ActivityNoteDateFormatted": "2017-05-15T14:33:57.010-06:00",
"CaseActivityNoteId": 228,
"CaseId": 7747,
"FirstName": "Mark",
"FullName": "Mark Smith",
"HashCode": "0EBA6225C0F00A3ABE777797B61AE1CB7CD9D57B",
"LastName": "Smith",
"NoteFile": null,
"UserId": "861728bb-b83e-4946-ac14-0055b610c2f9"
}
],
"AlertName": "Alert 1 - DEV",
"CaseId": 7747,
"CasePriorityTypeId": 0,
"CaseRootCauseAnswers": [],
"CaseRootCauseTreeIds": [],
"CaseStatusTypeId": 3,
"CaseTriggerId": 301,
"CaseWatchers": [
{
"Access": 1,
"Email": "steve.Smith@maritzcx.com",
"Id": "02198098-8844-441b-8e18-081d57e87194",
"Name": "Steve Smith"
}
],
"CurrentUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"DateClosed": "/Date(1494880528940-0600)/",
"DateClosedFormatted": "2017-05-15T14:35:28.940-06:00",
"DateSubmitted": "/Date(1494527490803-0600)/",
"DateSubmittedFormatted": "2017-05-11T12:31:30.803-06:00",
"DisableCaseReassignmentNotifications": false,
"DisableCaseWatcherNotifications": false,
"FirstName": "Mark",
"ItemAnswers": [],
"LastName": "Smith",
"ModifiedDate": "/Date(1527279871763-0600)/",
"ModifiedDateFormatted": "2018-05-25T14:24:31.763-06:00",
"OwnerEmail": "mark.Smith@maritzcx.com",
"OwnerFullName": "Mark Smith",
"OwnerUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"ProgramName": "mlk Program 1'ab",
"RespondentHash": null,
"RespondentId": 18340,
"SourceName": "",
"SourceResponses": [
{
"Key": -280,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "How did you originally become aware of the Dräger training?",
"ScaleId": 280
}
},
{
"Key": -1034,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 5857,
"AnswerIds": [
5857
],
"AnswerText": "Probably Not",
"DisplayType": 0,
"QuestionText": "NPS Question ",
"ScaleId": 1034
}
},
{
"Key": -1053,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "First Name",
"ScaleId": 1053
}
},
{
"Key": -1131,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "Franchise ID:",
"ScaleId": 1131
}
},
{
"Key": -1591,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "new Tac",
"ScaleId": 1591
}
}
],
"SourceValues": [
{
"Key": "item_-280",
"Value": "How did you originally become aware of the Dräger training?"
},
{
"Key": "item_-1034",
"Value": "NPS Question "
},
{
"Key": "item_-1053",
"Value": "First Name"
},
{
"Key": "item_-1131",
"Value": "Franchise ID:"
},
{
"Key": "item_-1591",
"Value": "new Tac"
}
],
"SurveyId": 79,
"SurveyName": "mlk Survey 1",
"SurveyResponseDate": "/Date(1494527458000-0600)/",
"SurveyResponseDateFormatted": "2017-05-11T12:30:58.000-06:00",
"TimeToClose": 353038,
"TimeToCloseColor": 1,
"TimeToCloseDays": 4,
"TimeToCloseDisplay": "4d 2h",
"TimeToCloseGoal": 14400,
"TimeToCloseGoalDays": 0,
"TimeToCloseGoalDisplay": "0d 4h",
"TimeToCloseGoalHours": 4,
"TimeToCloseHours": 2,
"TimeToRespond": 352947,
"TimeToRespondColor": 1,
"TimeToRespondDays": 4,
"TimeToRespondDisplay": "4d 2h",
"TimeToRespondGoal": 7200,
"TimeToRespondGoalDays": 0,
"TimeToRespondGoalDisplay": "0d 2h",
"TimeToRespondGoalHours": 2,
"TimeToRespondHours": 2,
"WatcherType": 0
}
],
"CaseFormSettings": null,
"CaseProgramId": 82,
"CaseViewSettings": {
"CaseCanvasSettings": "{\"height\":\"11in\",\"width\":\"754px\",\"showGrid\":true,\"showPageBreaks\":false,\"paperSize\":\"letter\"}",
"CaseStatusIds": [
1,
2,
3
],
"CaseViewItems": [
{
"CaseId": 0,
"CaseItemId": 2997,
"CaseItemText": "",
"CaseProgramId": 82,
"CaseQuestionTypeId": 18,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":60,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":0,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2997",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 0,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 2998,
"CaseItemText": "",
"CaseProgramId": 82,
"CaseQuestionTypeId": 19,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":360,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":1,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2998",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 1,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 2999,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":180,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":2,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2999",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 2,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3000,
"CaseItemText": "I&D:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 1,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"I&D:\",\"required\":\"\",\"top\":240,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":3,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":null,\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":null,\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3000",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 3,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3001,
"CaseItemText": "CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 3,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CREATED:\",\"required\":\"\",\"top\":300,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":4,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3001",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 4,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3002,
"CaseItemText": "CLOSED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 16,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CLOSED:\",\"required\":\"\",\"top\":360,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":5,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3002",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 5,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3003,
"CaseItemText": "OWNER",
"CaseProgramId": 82,
"CaseQuestionTypeId": 9,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OWNER\",\"required\":\"\",\"top\":420,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":6,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3003",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 6,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3004,
"CaseItemText": "PRIORITY",
"CaseProgramId": 82,
"CaseQuestionTypeId": 5,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3004,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1034,
"Operator": 4,
"SourceId": 79,
"Values": [
"5856",
"5857"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink666",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget666",
"RootCauseTreeIdNodes": [],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [
{
"Id": 0,
"LocalizedLabel": "shared.noneSelected",
"Text": null
},
{
"Id": 1,
"LocalizedLabel": "shared.high",
"Text": null
},
{
"Id": 2,
"LocalizedLabel": "shared.medium",
"Text": null
},
{
"Id": 3,
"LocalizedLabel": "shared.low",
"Text": null
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"PRIORITY\",\"required\":\"\",\"top\":510,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":7,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3004",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 7,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3005,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":180,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":8,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3005",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 8,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3006,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Ainformation%20such%20as%20customer%20name%20and%20contact%20details%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":240,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Ainformation%20such%20as%20customer%20name%20and%20contact%20details%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":9,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3006",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 9,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3007,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ERESPONSE%20SUMMARY%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":360,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ERESPONSE%20SUMMARY%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":10,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3007",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 10,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3008,
"CaseItemText": "SURVEY TAKEN:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 17,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"SURVEY TAKEN:\",\"required\":\"\",\"top\":420,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":11,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3008",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 11,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3009,
"CaseItemText": "ALERT CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 10,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ALERT CREATED:\",\"required\":\"\",\"top\":480,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":12,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3009",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 12,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3010,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Arelevant%20survey%20response%20excerpts%20such%20as%20overall%20satisfaction%20or%3Cbr%20%2F%3E%0Alikelihood%20to%20recommend%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":540,\"left\":390,\"width\":360,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Arelevant%20survey%20response%20excerpts%20such%20as%20overall%20satisfaction%20or%3Cbr%20%2F%3E%0Alikelihood%20to%20recommend%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":13,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3010",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 13,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3011,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20ACTIVITY%20AND%20RESOLUTION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":780,\"left\":30,\"width\":630,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20ACTIVITY%20AND%20RESOLUTION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":14,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3011",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 14,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3012,
"CaseItemText": "CASE STATUS",
"CaseProgramId": 82,
"CaseQuestionTypeId": 4,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": 1,
"LocalizedLabel": "shared.new",
"Text": null
},
{
"Id": 2,
"LocalizedLabel": "shared.inProgress",
"Text": null
},
{
"Id": 3,
"LocalizedLabel": "shared.closed",
"Text": null
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CASE STATUS\",\"required\":\"\",\"top\":840,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":15,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3012",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 15,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3013,
"CaseItemText": "OUTCOME",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3013,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1034,
"Operator": 4,
"SourceId": 79,
"Values": [
"5858",
"5859"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink667",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget667",
"RootCauseTreeIdNodes": [],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [
{
"Id": 651,
"LocalizedLabel": null,
"Text": "Resolved"
},
{
"Id": 652,
"LocalizedLabel": null,
"Text": "Unable to contact"
},
{
"Id": 653,
"LocalizedLabel": null,
"Text": "Unresolved"
},
{
"Id": 654,
"LocalizedLabel": null,
"Text": "Other"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OUTCOME\",\"required\":\"required\",\"top\":930,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":16,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3013",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 16,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3014,
"CaseItemText": "RESOLUTION DESCRIPTION",
"CaseProgramId": 82,
"CaseQuestionTypeId": 12,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"RESOLUTION DESCRIPTION\",\"required\":\"required\",\"top\":1410,\"left\":30,\"width\":330,\"height\":180,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":17,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3014",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 17,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3015,
"CaseItemText": "ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [
{
"CaseItemId": 3015,
"CaseItemListIds": [],
"DisplayFilter": {
"DataType": 0,
"FilterSourceType": 0,
"Filters": [
{
"DataType": 0,
"FilterSourceType": 4,
"Filters": [],
"IsGroup": false,
"Metric": 1591,
"Operator": 4,
"SourceId": 79,
"Values": [
"9684",
"9685"
]
}
],
"IsGroup": true,
"Metric": 0,
"Operator": 2,
"SourceId": 79,
"Values": []
},
"HyperlinkText": "casedynamicitem.hyperlink665",
"HyperlinkUrl": "casedynamicitem.hyperlinktarget665",
"RootCauseTreeIdNodes": [
"j7_1",
"j7_3",
"j7_4"
],
"TargetVisibilityTypeId": 1
}
],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ROOT CAUSE\",\"required\":\"required\",\"top\":840,\"left\":390,\"width\":360,\"height\":240,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3015",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6348,
"ParentTreeId": "#",
"RootCauseName": "Root Cause2 & Section 1",
"SortPosition": 0,
"TreeId": "j7_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6669,
"ParentTreeId": "j7_1",
"RootCauseName": "A child 1",
"SortPosition": 1,
"TreeId": "j8_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6670,
"ParentTreeId": "j8_1",
"RootCauseName": "a sub child",
"SortPosition": 2,
"TreeId": "j8_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6351,
"ParentTreeId": "#",
"RootCauseName": "Root cause2 section 2",
"SortPosition": 3,
"TreeId": "j7_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6663,
"ParentTreeId": "j7_2",
"RootCauseName": "1",
"SortPosition": 4,
"TreeId": "j8_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6664,
"ParentTreeId": "j7_2",
"RootCauseName": "2",
"SortPosition": 5,
"TreeId": "j8_4"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6665,
"ParentTreeId": "j7_2",
"RootCauseName": "3",
"SortPosition": 6,
"TreeId": "j8_5"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6666,
"ParentTreeId": "j7_2",
"RootCauseName": "4",
"SortPosition": 7,
"TreeId": "j8_6"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6667,
"ParentTreeId": "j7_2",
"RootCauseName": "5",
"SortPosition": 8,
"TreeId": "j8_7"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6668,
"ParentTreeId": "j7_2",
"RootCauseName": "New node",
"SortPosition": 9,
"TreeId": "j8_8"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6540,
"ParentTreeId": "#",
"RootCauseName": "New root",
"SortPosition": 10,
"TreeId": "j3_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6561,
"ParentTreeId": "#",
"RootCauseName": "Another Node",
"SortPosition": 11,
"TreeId": "j21_1"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3016,
"CaseItemText": "%3Cp%3E%3Cem%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3EEnter%20an%20activity%20note%20each%20time%20you%20work%20the%20case%20that%20describes%20the%20action%20taken.%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fem%3E%3C%2Fp%3E%0A",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":1230,\"left\":30,\"width\":720,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cem%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3EEnter%20an%20activity%20note%20each%20time%20you%20work%20the%20case%20that%20describes%20the%20action%20taken.%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fem%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":19,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3016",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 19,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3017,
"CaseItemText": "ACTIVITY NOTES",
"CaseProgramId": 82,
"CaseQuestionTypeId": 7,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ACTIVITY NOTES\",\"required\":\"\",\"top\":1260,\"left\":30,\"width\":720,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":20,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3017",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 20,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3172,
"CaseItemText": "View/Add Watchers:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 22,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#8cc652\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"View/Add Watchers:\",\"required\":\"\",\"top\":630,\"left\":30,\"width\":300,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":22,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3172",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 22,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3294,
"CaseItemText": "Case Program Name:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 2,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Case Program Name:\",\"required\":\"\",\"top\":690,\"left\":30,\"width\":300,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":23,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3294",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 23,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3447,
"CaseItemText": "Dropdown 2",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": 798,
"LocalizedLabel": null,
"Text": "red"
},
{
"Id": 799,
"LocalizedLabel": null,
"Text": "blue"
},
{
"Id": 800,
"LocalizedLabel": null,
"Text": "white"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Dropdown 2\",\"required\":\"\",\"top\":1050,\"left\":30,\"width\":120,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":24,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3447",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 24,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3535,
"CaseItemText": "Date Picker",
"CaseProgramId": 82,
"CaseQuestionTypeId": 26,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Date Picker\",\"required\":\"\",\"top\":1140,\"left\":390,\"width\":390,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":25,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":true,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3535",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 25,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 0,
"CaseItemId": 3716,
"CaseItemText": "Color ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Color ROOT CAUSE\",\"required\":\"required\",\"top\":1110,\"left\":0,\"width\":390,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3716",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6578,
"ParentTreeId": "#",
"RootCauseName": "Colors",
"SortPosition": 0,
"TreeId": "j11_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6579,
"ParentTreeId": "j11_1",
"RootCauseName": "Red",
"SortPosition": 1,
"TreeId": "j11_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6580,
"ParentTreeId": "j11_1",
"RootCauseName": "Green",
"SortPosition": 2,
"TreeId": "j11_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6581,
"ParentTreeId": "j11_1",
"RootCauseName": "Blue",
"SortPosition": 3,
"TreeId": "j11_4"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
}
],
"ClosingStatusIds": [
3
],
"IsActionPlan": false,
"NewStatusId": 1
},
"NumberOfCasesModified": 1
}
],
"respondentIdsNotCases": "",
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"ExportCasesByRespondentIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)."
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"ExportCasesByRespondentIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "respondentIds list is empty"
}
}
An empty list of Respondent IDs was passed in.
HTTP Status Code: 403
{
"ExportCasesByRespondentIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "Error: Not logged in or unauthorized."
}
}
An expired or invalid token was passed in.
HTTP Status Code: 403
{
"ExportCasesByRespondentIDResult": {
"caseExport": null,
"respondentIdsNotCases": null,
"statusMessage": "User Doesn't Have Access To Export"
}
}
The logged-in user doesn’t have case program admin privilege, which is necessary to do exports.
Sample Call
TBD
Notes
POST getCaseView
Returns specific case details with the current values.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
An integer representing the case view to get, retrieved by the endpoint getMobileCaseInboxItems.
removeTimeFields=[boolean] Optional
If true, will remove TimeToRespond and TimeToClose from the CaseItems in getCaseView.
Sample Request
{
"token":"3ebb192d-57bb-44cd-8b0d-28014ce823e4",
"caseId":"1"
}
Response Values
GetCaseViewResult=[object]
Complex top-level response object returned by this endpoint. Composed of the following children:
caseView=[object]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
statusMessage=[string]
Result of the request. Possible Values are 1) “Successful” – Case details were returned, accompanied by an HTTP status code of 200; and 2) Error Message.
viewValues=[array]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
messagingEnabled=[boolean]
True if the case supports messaging.
caseOwnerEnabled=[boolean]
Returns true if the logged in user is able to modify the owner, otherwise returns false.
viewAddWatchersEnabled=[boolean]
Returns true if the logged-in user is able to modify the watchers list, otherwise returns false.
Sample Response
{
"GetCaseViewResult": {
"caseOwnerEnabled": false,
"caseView": {
"CaseCanvasSettings":
"{
\"canvasSettings\":{
\"height\":\"11in\",
\"width\":\"754px\",
\"showGrid\":true,
\"showPageBreaks\":false,
\"paperSize\":\"letter\"
},
\"elements\":[
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"18\",
\"datadefinitionid\":\"0\",
\"text\":\"\",
\"required\":false,
\"top\":60,
\"left\":60,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1045,
\"mobileIndex\":0,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1045\"
},
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"19\",
\"datadefinitionid\":\"0\",
\"text\":\"\",
\"required\":false,
\"top\":60,
\"left\":360,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1046,
\"mobileIndex\":1,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1046\"
},
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"20\",
\"datadefinitionid\":\"0\",
\"text\":\"\",
\"required\":false,
\"top\":180,
\"left\":30,
\"width\":300,
\"height\":120,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":
\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3C
span%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3C
span%20style%3D%22font-family%3Averdana%2Cgeneva%2C
sans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1047,
\"mobileIndex\":2,
\"parentItemID\":-1,
\"hasChildren\":true,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1047\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"1\",
\"datadefinitionid\":\"0\",
\"text\": \"ID:\",
\"required\":false,
\"top\":240,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1048,
\"mobileIndex\":3,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1048\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"3\",
\"datadefinitionid\":\"0\",
\"text\": \"CREATED:\",
\"required\":false,
\"top\":300,
\"left\":30,
\"width\":330,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1049,
\"mobileIndex\":4,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1049\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"16\",
\"datadefinitionid\":\"0\",
\"text\": \"CLOSED:\",
\"required\":false,
\"top\":360,
\"left\":30,
\"width\":330,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1050,
\"mobileIndex\":5,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1050\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"9\",
\"datadefinitionid\":\"0\",
\"text\":\"OWNER\",
\"required\":false,
\"top\":420,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1051,
\"mobileIndex\":6,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1051\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"4\",
\"datadefinitionid\":\"0\",
\"text\":\"CASE STATUS\",
\"required\":false,
\"top\":510,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1052,
\"mobileIndex\":7,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1052\"
},
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"20\",
\"datadefinitionid\":\"0\",
\"text\":\"\",
\"required\":false,
\"top\":180,
\"left\":390,
\"width\":360,
\"height\":120,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":
\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan
%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3C
span%20style%3D%22font-family%3Averdana%2Cgeneva%2C
sans-serif%22%3ECUSTOMER%20INFORMATION%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1053,
\"mobileIndex\":8,
\"parentItemID\":-1,
\"hasChildren\":true,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1053\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"17\",
\"datadefinitionid\":\"0\",
\"text\": \"SURVEY TAKEN:\",
\"required\":false,
\"top\":240,
\"left\":390,
\"width\":360,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1054,
\"mobileIndex\":9,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1054\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"10\",
\"datadefinitionid\":\"0\",
\"text\": \"ALERT CREATED:\",
\"required\":false,
\"top\":300,
\"left\":390,
\"width\":360,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1055,
\"mobileIndex\":10,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1055\"
},
{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"7\",
\"datadefinitionid\":\"0\",
\"text\":\"ACTIVITY NOTES\",
\"required\":false,
\"top\":600,
\"left\":30,
\"width\":720,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1057,
\"mobileIndex\":12,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1057\"
},
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"15\",
\"datadefinitionid\":103,
\"text\":\"\",
\"required\":false,
\"top\":480,
\"left\":390,
\"width\":300,
\"height\":30,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1058,
\"mobileIndex\":14,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"dataReferenceFormatType\":\"1\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1058\"
},
{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"15\",
\"datadefinitionid\":104,
\"text\":\"\",
\"required\":false,
\"top\":450,
\"left\":390,
\"width\":300,
\"height\":30,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":[
],
\"treeobject\":[
],
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1059,
\"mobileIndex\":15,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"dataReferenceFormatType\":\"1\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1059\"
}
]
}",
"CaseStatusIds": [
202,
203,
204
],
"CaseViewItems": [
{
"CaseId": 2686,
"CaseItemId": 1045,
"CaseItemText": "Time to respond",
"CaseProgramId": 68,
"CaseQuestionTypeId": 18,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"18\",
\"datadefinitionid\":\"0\",
\"text\":\"\",
\"required\":false,
\"top\":60,
\"left\":60,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{},
\"treeobject\":{},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1045,
\"mobileIndex\":0,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1045\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1045",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 0,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1046,
"CaseItemText": "Time to close",
"CaseProgramId": 68,
"CaseQuestionTypeId": 19,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"19\",
\"datadefinitionid\":\"0\",
\"text\":\"\",\"required\":false,
\"top\":60,
\"left\":360,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{},
\"treeobject\":{},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1046,
\"mobileIndex\":1,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1046\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1046",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 1,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1047,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3C
span%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20
style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif
%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 68,
"CaseQuestionTypeId": 20,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"20\",
\"datadefinitionid\":\"0\",
\"text\":\"CASE INFORMATION\\n\",
\"required\":false,
\"top\":180,
\"left\":30,
\"width\":300,
"height\":120,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3C
span%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20
style%3D%22font-family%3Averdana%2Cgeneva%2C
sans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",
\"itemlist\":{},
\"treeobject\":{},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1047,
\"mobileIndex\":2,
\"parentItemID\":-1,
\"hasChildren\":true,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1047\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1047",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": true,
"mobileIndex": 2,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1048,
"CaseItemText": "ID:",
"CaseProgramId": 68,
"CaseQuestionTypeId": 1,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"1\",
\"datadefinitionid\":\"0\",
\"text\": \"ID:\",
\"required\":false,
\"top\":240,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1048,
\"mobileIndex\":3,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1048\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1048",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 3,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1049,
"CaseItemText": "CREATED:",
"CaseProgramId": 68,
"CaseQuestionTypeId": 3,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"3\",
\"datadefinitionid\":\"0\",
\"text\": \"CREATED:\",
\"required\":false,
\"top\":300,
\"left\":30,
\"width\":330,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1049,
\"mobileIndex\":4,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1049\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1049",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 4,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1050,
"CaseItemText": "CLOSED:",
"CaseProgramId": 68,
"CaseQuestionTypeId": 16,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"16\",
\"datadefinitionid\":\"0\",
\"text\": \"CLOSED:\",
\"required\":false,
\"top\":360,
\"left\":30,
\"width\":330,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1050,
\"mobileIndex\":5,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1050\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1050",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 5,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1051,
"CaseItemText": "OWNER",
"CaseProgramId": 68,
"CaseQuestionTypeId": 9,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"9\",
\"datadefinitionid\":\"0\",
\"text\":\"OWNER\",
\"required\":false,
\"top\":420,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1051,
\"mobileIndex\":6,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1051\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1051",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 6,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1052,
"CaseItemText": "CASE STATUS",
"CaseProgramId": 68,
"CaseQuestionTypeId": 4,
"DefaultValue": null,
"DropdownValues": [
{
"Id": 203,
"LocalizedLabel": "shared.inProgress",
"Text": "In Progress"
},
{
"Id": 204,
"LocalizedLabel": "shared.closed",
"Text": "Closed"
}
],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"4\",
\"datadefinitionid\":\"0\",
\"text\":\"CASE STATUS\",
\"required\":false,
\"top\":510,
\"left\":30,
\"width\":330,
\"height\":90,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1052,
\"mobileIndex\":7,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1052\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1052",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 7,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1053,
"CaseItemText": "%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3C
span%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3C
span%20style%3D%22font-family%3Averdana%2Cgeneva%2C
sans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fp%3E%0A",
"CaseProgramId": 68,
"CaseQuestionTypeId": 20,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"20\",
\"datadefinitionid\":\"0\",
\"text\":\"CUSTOMER INFORMATION\\n\",
\"required\":false,
\"top\":180,
\"left\":390,
\"width\":360,
\"height\":120,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3C
span%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3C
span%20style%3D%22font-family%3Averdana%2Cgeneva%2C
sans-serif%22%3ECUSTOMER%20INFORMATION%3C%2F
span%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1053,
\"mobileIndex\":8,
\"parentItemID\":-1,
\"hasChildren\":true,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1053\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1053",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": true,
"mobileIndex": 8,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1054,
"CaseItemText": "SURVEY TAKEN:",
"CaseProgramId": 68,
"CaseQuestionTypeId": 17,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"17\",
\"datadefinitionid\":\"0\",
\"text\": \"SURVEY TAKEN:\",
\"required\":false,
\"top\":240,
\"left\":390,
\"width\":360,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1054,
\"mobileIndex\":9,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1054\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1054",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 9,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1055,
"CaseItemText": "ALERT CREATED:",
"CaseProgramId": 68,
"CaseQuestionTypeId": 10,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":\"400\",
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"verdana\",
\"contentFontSize\":\"16px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"10\",
\"datadefinitionid\":\"0\",
\"text\": \"ALERT CREATED:\",
\"required\":false,
\"top\":300,
\"left\":390,
\"width\":360,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1055,
\"mobileIndex\":10,
\"parentItemID\":0,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1055\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1055",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 10,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1057,
"CaseItemText": "ACTIVITY NOTES",
"CaseProgramId": 68,
"CaseQuestionTypeId": 7,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":\"400\",
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"verdana\",
\"labelFontSize\":\"16px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"7\",
\"datadefinitionid\":\"0\",
\"text\":\"ACTIVITY NOTES\",
\"required\":false,
\"top\":600,
\"left\":30,
\"width\":720,
\"height\":150,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1057,
\"mobileIndex\":12,
\"dataReferenceContactType\":\"0\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceFormatType\":\"1\",
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1057\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1057",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 12,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1058,
"CaseItemText": "Survey Excerpt",
"CaseProgramId": 68,
"CaseQuestionTypeId": 15,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"15\",
\"datadefinitionid\":103,
\"text\":\"\",
\"required\":false,
\"top\":480,
\"left\":390,
\"width\":300,
\"height\":30,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1058,
\"mobileIndex\":14,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"dataReferenceFormatType\":\"1\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1058\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1058",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 14,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 2686,
"CaseItemId": 1059,
"CaseItemText": "Survey Excerpt",
"CaseProgramId": 68,
"CaseQuestionTypeId": 15,
"DefaultValue": null,
"DropdownValues": [],
"FormatString": "{
\"labelFontWeight\":400,
\"labelFontStyle\":\"normal\",
\"labelTextDecoration\":\"none\",
\"labelFontFamily\":\"arial\",
\"labelFontSize\":\"12px\",
\"labelColor\":\"#000000\",
\"contentFontWeight\":400,
\"contentFontStyle\":\"normal\",
\"contentTextDecoration\":\"none\",
\"contentFontFamily\":\"arial\",
\"contentFontSize\":\"12px\",
\"contentColor\":\"#000000\",
\"borderColor\":\"#000\",
\"borderWidth\":\"1px\",
\"borderStyle\":\"solid\",
\"questionTypeID\":\"15\",
\"datadefinitionid\":104,
\"text\":\"\",
\"required\":false,
\"top\":450,
\"left\":390,
\"width\":300,
\"height\":30,
\"ffWidth\":null,
\"ffHeight\":null,
\"contentText\":null,
\"itemlist\":{
},
\"treeobject\":{
},
\"allowother\":false,
\"displayGoal\":true,
\"caseItemID\":1059,
\"mobileIndex\":15,
\"parentItemID\":-1,
\"hasChildren\":false,
\"dataReferenceContactType\":\"0\",
\"dataReferenceFormatType\":\"1\",
\"adminOnlyOwnershipChange\":false,
\"showTimeField\":false,
\"filterUsers\":false,
\"Version\":1,
\"resourceKeyName\":\"caseitem.text1059\"
}",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text1059",
"RootCauseValues": [],
"SourceScaleId": 0,
"isGroupParent": false,
"mobileIndex": 15,
"parentItemID": 0,
"showTimeField": false
}
],
"ClosingStatusIds": [
204
],
"IsActionPlan": false,
"NewStatusId": 202
},
"messagingEnabled": true,
"statusMessage": "Successful",
"viewAddWatchersEnabled": false,
"viewValues": {
"ActivityNotes": [],
"AlertName": "Moab Case Creation",
"CaseId": 2686,
"CasePriorityId": 0,
"CaseRootCauseAnswers": [],
"CaseRootCauseTreeIds": [],
"CaseStatusId": 203,
"CaseWatchers": [
{
"Access": 2,
"Id": "76ed0b2e-7e84-49ed-b478-df8c75b9290d",
"Name": "Mark Kolp"
},
{
"Access": 1,
"Id": "41c569e7-8f92-415b-810f-dfd4dc2e7eea",
"Name": "Phil Harker"
},
{
"Access": 1,
"Id": "ef389fd5-bbb0-4c6e-a763-c4402e2f021c",
"Name": "Steve Analyst Richins"
}
],
"CurrentUserId": "76ed0b2e-7e84-49ed-b478-df8c75b9290d",
"DateClosed": "/Date(-62135402400000-0600)/",
"DateClosedFormatted": "",
"DateSubmitted": "/Date(1481914218113-0600)/",
"DateSubmittedFormatted": "2016-12-16T12:50:18.113-06:00",
"DisableCaseReassignmentNotifications": false,
"DisableCaseWatcherNotifications": false,
"FirstName": "Steve",
"ItemAnswers": [],
"LastName": "Richins",
"ModifiedDate": "/Date(1481914218117-0600)/",
"ModifiedDateFormatted": "2016-12-16T12:50:18.117-06:00",
"OwnerFullName": "Steve Richins",
"OwnerUserId": "02198098-8844-441b-8e18-081d57e87194",
"ProgramName": "Steve’s Nov 2016 Program",
"RespondentHash": null,
"RespondentId": 3207,
"SourceName": "",
"SourceResponses": [
{
"Key": 1059,
"Value": {
"AnswerText": "Chesler Park",
"DisplayType": 3,
"QuestionText": "What is your favorite hike?"
}
},
{
"Key": 1058,
"Value": {
"AnswerText": "Fallback here",
"DisplayType": 3,
"QuestionText": "Do you feel better now?"
}
}
],
"SourceValues": [
{
"Key": "item_1059",
"Value": "What is your favorite hike? Chesler Park"
},
{
"Key": "item_1058",
"Value": "Do you feel better now? Fallback here"
}
],
"SurveyId": 71,
"SurveyName": "Steve’s November 2016 Survey",
"TimeToClose": 1556397,
"TimeToCloseColor": 0,
"TimeToCloseDays": 18,
"TimeToCloseDisplay": "18d 0h",
"TimeToCloseGoal": 0,
"TimeToCloseGoalDays": 0,
"TimeToCloseGoalDisplay": "",
"TimeToCloseGoalHours": 0,
"TimeToCloseHours": 0,
"TimeToRespond": 1556397,
"TimeToRespondColor": 0,
"TimeToRespondDays": 18,
"TimeToRespondDisplay": "18d 0h",
"TimeToRespondGoal": 0,
"TimeToRespondGoalDays": 0,
"TimeToRespondGoalDisplay": "",
"TimeToRespondGoalHours": 0,
"TimeToRespondHours": 0,
"WatcherType": 2
}
}
}
Error Response
HTTP Status Code: 400
{
"GetCaseViewResult":{
"statusMessage":" GUID format error:
Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"GetCaseViewResult":{
"statusMessage":"An error occurred logging out.
Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"GetCaseViewResult":{
"caseView":null,
"statusMessage":"Error: Not logged in or unauthorized.",
"viewValues":null
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST getExternalRemeasurementCasesByDate
Retrieves all the “new” cases that have an external remeasurement survey waiting to be performed.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
startDate=[string] Required
The start date/time to query for, e.g. “01-01-1970 12:00 AM”. All queries are performed in DB time, which is in the Central time zone.
endDate=[string] Required
The end date/time to query for, e.g. “09-14-2017 12:00 AM”. All queries are performed in DB time, which is in the Central time zone.
Sample Request
{"token": "0ed0d524-14b1-4ee5-84f4-c693a31613cd",
"startDate":"01-01-1970 12:00 AM",
"endDate": "09-14-2017 12:00 AM"
}
Response Values
GetExternalRemeasurementCasesByDateResult=[object]
Complex top-level response object returned by this endpoint. Composed of the following children:
caseRemeasurementExport=[object]
Complex top-level response object returned by this endpoint. Composed of the following children:
CaseExportViewValues=[array]
Complex second-level response object returned by this endpoint. Contains the following children:
CaseViewValuesRemeasurement=[array]
Complex top-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
RespondentInfo=[string]
JSON string of Survey information that details the necessary objects for sending an email invitation. Here’s an example of the format:
[{"ScaleId" : "1098",
"ScaleTag" : "",
"QuestionTag" : "ALERT_NAME",
"QuestionScaleId" : null,
"Value" : "NPS 0-6"},
{...}]
statusMessage=[string]
Value that indicates the result of the request to create a new message. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"GetExternalRemeasurementCasesByDateResult": {
"caseRemeasurementExport": {
"CaseExportViewValues": [
{
"CaseViewValuesRemeasurement": {
"ActivityNotes": [],
"AlertName": "NPS 0-6",
"CaseId": 8010,
"CasePriorityId": 242,
"CaseRootCauseAnswers": [
{
"CaseItemId": 1203,
"CaseRootCauseId": 4835,
"TreeId": "j7_3"
}
],
"CaseRootCauseTreeIds": [
"j7_3"
],
"CaseStatusId": 243,
"CaseWatchers": [
{
"Access": 1,
"Email": "auser@maritzcx.com",
"Id": "792ac27e-4459-4857-9659-5a3970389ba8",
"Name": "John Doe"
},
{
"Access": 1,
"Email": "auser1@gmail.com",
"Id": "0ffb8144-9e6a-415c-aa28-c8ebb8ab2220",
"Name": "DanO Reader"
},
{
"Access": 1,
"Email": "auser2@maritzcx.com",
"Id": "861728bb-b83e-4946-ac14-0055b610c2f9",
"Name": "Biff Tanner"
}
],
"CurrentUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"DateClosed": "/Date(1505230679023-0400)/",
"DateClosedFormatted": "2017-09-12T11:37:59.023-04:00",
"DateSubmitted": "/Date(1505150858133-0400)/",
"DateSubmittedFormatted": "2017-09-11T13:27:38.133-04:00",
"DisableCaseReassignmentNotifications": false,
"DisableCaseWatcherNotifications": false,
"FirstName": "Dan",
"ItemAnswers": [
{
"BoolValue": false,
"CaseId": 8010,
"CaseItemAnswerId": 434,
"CaseItemId": 1201,
"CaseQuestionTypeId": 13,
"DoubleValue": 0,
"IntValue": 208,
"IsEmpty": false,
"TextValue": null,
"TimeValue": "/Date(-62135406000000-0500)/"
},
{
"BoolValue": false,
"CaseId": 8010,
"CaseItemAnswerId": 437,
"CaseItemId": 1202,
"CaseQuestionTypeId": 12,
"DoubleValue": 0,
"IntValue": 0,
"IsEmpty": false,
"TextValue": ".",
"TimeValue": "/Date(-62135406000000-0500)/"
}
],
"LastName": "Doe",
"ModifiedDate": "/Date(1505230679117-0400)/",
"ModifiedDateFormatted": "2017-09-12T11:37:59.117-04:00",
"OwnerEmail": "John.Doe@maritzcx.com",
"OwnerFullName": "John Doe",
"OwnerUserId": "792ac27e-4459-4857-9659-5a3970389ba8",
"ProgramName": "DanO Case Program 1",
"RespondentHash": null,
"RespondentId": 18717,
"SourceName": "",
"SourceResponses": [
{
"Key": 1289,
"Value": {
"AnswerText": "(Not Answered)",
"DisplayType": 1,
"QuestionText": "Survey question date:"
}
},
{
"Key": 1308,
"Value": {
"AnswerText": "(Not Answered)",
"DisplayType": 3,
"QuestionText": "Which colors do you like?"
}
},
{
"Key": 1309,
"Value": {
"AnswerText": "3",
"DisplayType": 1,
"QuestionText": "NPS Score:"
}
},
{
"Key": 1208,
"Value": {
"AnswerText": "auser@maritzcx.com",
"DisplayType": 1,
"QuestionText": "Email: "
}
},
{
"Key": 1206,
"Value": {
"AnswerText": "2017-09-11.2",
"DisplayType": 1,
"QuestionText": "Last Name: "
}
},
{
"Key": 1303,
"Value": {
"AnswerText": "DanO",
"DisplayType": 3,
"QuestionText": "First Name:"
}
}
],
"SourceValues": [
{
"Key": "item_1289",
"Value": "(Not Answered)"
},
{
"Key": "item_1308",
"Value": "Which colors do you like? (Not Answered)"
},
{
"Key": "item_1309",
"Value": "3"
},
{
"Key": "item_1208",
"Value": "John.Doe@maritzcx.com"
},
{
"Key": "item_1206",
"Value": "2017-09-11.2"
},
{
"Key": "item_1303",
"Value": "First Name: DanO"
}
],
"SurveyId": 78,
"SurveyName": "DanO Case Survey 1",
"TimeToClose": 79821,
"TimeToCloseColor": 0,
"TimeToCloseDays": 0,
"TimeToCloseDisplay": "0d 22h",
"TimeToCloseGoal": 0,
"TimeToCloseGoalDays": 0,
"TimeToCloseGoalDisplay": "",
"TimeToCloseGoalHours": 0,
"TimeToCloseHours": 22,
"TimeToRespond": 79821,
"TimeToRespondColor": 0,
"TimeToRespondDays": 0,
"TimeToRespondDisplay": "0d 22h",
"TimeToRespondGoal": 0,
"TimeToRespondGoalDays": 0,
"TimeToRespondGoalDisplay": "",
"TimeToRespondGoalHours": 0,
"TimeToRespondHours": 22,
"WatcherType": 1
},
"RespondentInfo": "[{\"ScaleId\":\"1098\",\"ScaleTag\":\"\",\"QuestionTag\":\"ALERT_NAME\",\"QuestionScaleId\":null,\"Value\":\"NPS 0-6\"},{\"ScaleId\":\"1093\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_FULL_ACCESS_WATCHERS\",\"QuestionScaleId\":null,\"Value\":\"John Doe,Biff Tanner,DanO Reader\"},{\"ScaleId\":\"1092\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_FULL_ACCESS_WATCHERS_EMAIL\",\"QuestionScaleId\":null,\"Value\":\"John.Doe@maritzcx.com,Biff.Tanner@maritzcx.com,dobergfell+reader@gmail.com\"},{\"ScaleId\":\"1101\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_ID\",\"QuestionScaleId\":null,\"Value\":\"8010\"},{\"ScaleId\":\"1086\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_OWNER\",\"QuestionScaleId\":null,\"Value\":\"Dan Obergfell\"},{\"ScaleId\":\"1089\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_OWNER_EMAIL\",\"QuestionScaleId\":null,\"Value\":\"Biff.Tanner@maritzcx.com\"},{\"ScaleId\":\"1100\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_PRIORITY\",\"QuestionScaleId\":null,\"Value\":\"Medium\"},{\"ScaleId\":\"1088\",\"ScaleTag\":\"\",\"QuestionTag\":\"CASE_STATUS\",\"QuestionScaleId\":null,\"Value\":\"Closed\"},{\"ScaleId\":\"1094\",\"ScaleTag\":\"\",\"QuestionTag\":\"CLOSED_DATE\",\"QuestionScaleId\":null,\"Value\":\"9/12/2017\"},{\"ScaleId\":\"1096\",\"ScaleTag\":\"\",\"QuestionTag\":\"CREATED_ON_DATE\",\"QuestionScaleId\":null,\"Value\":\"9/11/2017\"},{\"ScaleId\":\"1106\",\"ScaleTag\":\"\",\"QuestionTag\":\"EMAIL_ADDRESS\",\"QuestionScaleId\":null,\"Value\":\"Biff.Tanner@maritzcx.com\"},{\"ScaleId\":\"1095\",\"ScaleTag\":\"\",\"QuestionTag\":\"MODIFIED_DATE\",\"QuestionScaleId\":null,\"Value\":\"9/12/2017\"},{\"ScaleId\":\"1085\",\"ScaleTag\":\"\",\"QuestionTag\":\"NPS\",\"QuestionScaleId\":null,\"Value\":\"3\"},{\"ScaleId\":\"1099\",\"ScaleTag\":\"\",\"QuestionTag\":\"PROGRAM_NAME\",\"QuestionScaleId\":null,\"Value\":\"DanO Case Program 1\"},{\"ScaleId\":\"1097\",\"ScaleTag\":\"\",\"QuestionTag\":\"SURVEY_NAME\",\"QuestionScaleId\":null,\"Value\":\"DanO Case Survey 1\"}]"
}
],
"NumberOfCases": 1
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 403
Not logged in or unauthorized
Need to log in using the authenticate endpoint.
HTTP Status Code: 400
Guid should contain 32
Improperly formatted authentication token was passed to the API.
HTTP Status Code: 400
Missing or empty token
Authentication token is missing and must be passed.
HTTP Status Code: 400
caseId must be greater than 0
A valid Case ID must be passed. Must be greater than 0.
HTTP Status Code: 500
Internal Error (with text reason)
Cause of the internal error, usually passing invalid data or an internal fault. If it persists please contact technical support.
Sample Call
TBD
Notes
- Survey must authenticated to be selected in Alert Setup Remeasurement page.
- Survey must have a short text field with Question tag set to: OriginalCaseId. This field must be filled in with the original CaseID or the remeasurement survey will not get associated with the Case.
- Will limit the number of responses to 500 – An exception will be returned if the list is over that amount, requiring a shorter time period.
POST getInteractionPointUserList
When a survey that’s associated with a case program has a hierarchy associated with it, there’s an option to filter the allowed users that can be watchers or owners. This endpoint will return that filtered list.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
An integer representing the case for which the filtered users are needed.
Sample Request
{
"token": "d8161373-2c94-476c-88d0-56a458ff15b2",
"caseId":7847
}
Response Values
GetInteractionPointUserListResult=[array]
Top-level response object returned by this endpoint. Composed of the following children:
hasHierarchy=[boolean]
True if the case is associated with a hierarchy, otherwise false.
statusMessage=[string]
Value that indicates the result of the getInteractionPointUserList request. Possible values are 1) “Successful” – Successful retrieval of user list, accompanied by an HTTP status code of 200; and 2) Error Message.
totalSearchCount=[int]
Count of the number of users returned in the userAccount array.
userAccount=[array]
A group of the following properties:
- Email[string] – The user’s email address.
- FullName[string] – The user’s full name; usually consists of the first name and last name concatenated.
- Hide[bool] – True if the value should be hidden from the user’s watcher list; false if it should be shown.
- UserId[GUID] – The GUID that represents the user’s identifier.
Sample Response
{
"GetInteractionPointUserListResult": {
"hasHierarchy": true,
"statusMessage": "Successful",
"totalSearchCount": 7,
"userAccount": [
{
"Email": "john.doe@maritzcx.com",
"FullName": "John Doe",
"Hide": false,
"UserId": "02198098-8844-444b-8e18-081d57e87194"
},
{
"Email": "dan.Tester@maritzcx.com",
"FullName": "Dan Tester",
"Hide": false,
"UserId": "82357754-915f-430f-ab0c-100166c71f59"
},
]
}
}
Error Response
HTTP Status Code: 400
{
"GetInteractionPointUserListResult":{
"statusMessage":" GUID format error:
Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"GetInteractionPointUserListResult":{
"statusMessage":"An error occurred logging out.
Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"GetInteractionPointUserListResult":{
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST getMessages
Gets a list of all messages for a specific case.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
Identifier of the case, retrieved by the endpoint getMobileCaseInboxItems.
Sample Request
{"token":"65356038-05d8-9c26-209b8c9d3eb9", "caseId":9}
Response Values
GetMessagesResult=[array]
Top-level response object returned by this endpoint, composed of the following elements:
statusMessage=[string]
Value that indicates the result of the request to get all messages. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
caseMessageInfo=[array]
Complex response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
Sample Response
{
"GetMessagesResult": {
"caseMessageInfo": {
"CaseID": 21140,
"CurrentUserName": null,
"EmailAddress": "jasmith@yahoo.com",
"EnableCaseMessaging": true,
"FirstName": "John",
"LastName": "Snith",
"MessageSubject": "here",
"Messages": [
{
"CaseID": 21140,
"CaseMessageID": 374,
"CaseMessageTypeID": 1,
"MessageDate": "/Date(1554411183500-0600)/",
"MessageDateFormatted": "Apr 4, 2019 2:53 PM",
"MessageFile": [],
"MessageText": "Test<br />\nAnother test",
"MessageUnread": false,
"ModifiedDate": "/Date(1554411183500-0600)/",
"RecordStatusTypeID": 1,
"UserID": "861728bb-b83e-4946-ac14-0055b610c2f9",
"UserName": "John Smith"
}
],
"MessagingEmployeeIdentificationLabel": "Customer Service Rep",
"MessagingLabel": "Customer Service Rep",
"PredefineTemplateCount": 4,
"TotalMessageCount": 1,
"TotalNewMessageCount": 0,
"UseAnonymousName": false,
"messageInfo": null
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 403
Not logged in or unauthorized
Need to log in using the authenticate endpoint.
HTTP Status Code: 400
Guid should contain 32
Improperly formatted authentication token was passed to the API.
HTTP Status Code: 400
Missing or empty token
Authentication token is missing and must be passed.
HTTP Status Code: 400
caseId must be greater than 0
A valid Case ID must be passed. Must be greater than 0.
HTTP Status Code: 500
Internal Error (with text reason)
Cause of the internal error, usually passing invalid data or an internal fault. If it persists please contact technical support.
Sample Call
TBD
Notes
POST getMessageScriptedResponses
Gets all scripted response messages for a case program.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
ID of the case for which a message needs to be created, retrieved by the endpoint getMobileCaseInboxItems.
Sample Request
{"token":"65356038-05d8-9c26-209b8c9d3eb9", "caseId":9}
Response Values
GetMessageScriptedResponsesResult=[array]
Top-level response object returned by this endpoint, composed of the following elements:
statusMessage=[string]
Value that indicates the result of the request to get all messages. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
totalResponseCount=[int]
Count of scripted responses.
casePredefinedResponse=[array]
Complex response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
Sample Response
{
"GetMessageScriptedResponsesResult": {
"casePredefinedResponse": [
{
"CasePredefinedResponseId": 2,
"CaseProgramId": 4,
"CreatedBy": "5771ca53-c124-41a7-b71d-3614c6d1f546",
"CreatedDate": "/Date(1473857867357-0400)/",
"DefaultAlerts": [],
"ModifiedDate": "/Date(1474312562630-0400)/",
"Name": "New Response ",
"RecordStatusTypeId": 1,
"Response": "<p>This is predefined response 1!</p>\n"
},
{
"CasePredefinedResponseId": 3,
"CaseProgramId": 4,
"CreatedBy": "5771ca53-c124-41a7-b71d-3614c6d1f546",
"CreatedDate": "/Date(1473857931540-0400)/",
"DefaultAlerts": [
{
"CasePredefinedResponseId": 3,
"CaseTriggerId": 0,
"CaseTriggerName": null
}
],
"ModifiedDate": "/Date(1473857931540-0400)/",
"Name": "2nd Reponse",
"RecordStatusTypeId": 1,
"Response": "<p>Another predefined response.</p>\n"
}
],
"statusMessage": "Successful",
"totalResponseCount": 2
}
}
Error Response
HTTP Status Code: 403
Not logged in or unauthorized
Need to log in using the authenticate endpoint.
HTTP Status Code: 400
Guid should contain 32
Improperly formatted authentication token was passed to the API.
HTTP Status Code: 400
Missing or empty token
Authentication token is missing and must be passed.
HTTP Status Code: 400
caseId must be greater than 0
A valid Case ID must be passed. Must be greater than 0.
HTTP Status Code: 500
Internal Error (with text reason)
Cause of the internal error, usually passing invalid data or an internal fault. If it persists please contact technical support.
Sample Call
TBD
Notes
POST getMobileCaseInboxItems
Returns a list of case items that the user has access to.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
filter=[array of strings] Optional
Filters applied to the case items. Possible values include “Assigned”, “Escalated”, “CC”, “New”, “InProgress”, “Closed”, “Overdue”, “ActionPlan”, and “NewMessages”. When you add the “ActionPlan” filter only Action Plan cases will be returned. When you omit this filter only Case Management cases are returned. When you add the “NewMessages” filter only cases with new messages will be returned.
sortBy=[string] Optional
Determines how to sort the list of case items. Can be any one of the following values: “Created”, “LastActivity”, “Score”, and “NewMessages”. When you use “NewMessages”, cases with new messages will be sorted at the top.
searchTerm=[string] Optional
String to restrict the inbox return set.
caseSensitiveSearch=[boolean] Optional
Determines whether or not the search is case-sensitive.
startPage=[int] Optional
Paging starts at 0, then increments up from there. Defaults to 0.
pageSize=[int] Optional
The number of items to return. Defaults to 50.
Sample Request
{
"token": "1757e380-dea3-4e73-b5ec-3a16fc7b1466",
"caseSensitiveSearch":false,
"searchTerm":"test",
"filter":["Assigned","CC","Closed"],
"pageSize":50,
"sortBy":"Created",
"startPage":0
}
Response Values
GetMobileCaseInboxItemsResult=[array]
Top-level response object returned by the endpoint, composed of the children caseMobileInboxData and statusMessage.
Second-level response object returned by the endpoint, composed of the children Rows, TotalNewCaseCount, and TotalNewMessageCount.
Rows=[array]
Complex response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
The result of the getMobileCaseInboxItems request. Possible values are 1) Successful – Successful return of case items, accompanied by an HTTP status code of 200; and 2) Error Message.
TotalNewCaseCount=[int]
Number of new cases, i.e. those that have not been opened.
TotalNewMessageCount=[int]
Number of new messages, i.e. those that have not been read.
Sample Response
{
"GetMobileCaseInboxItemsResult": {
"caseMobileInboxData": {
"Rows": [
{
"CaseId": 21140,
"Columns": [
{
"CaseQuestionTypeId": 1,
"ColumnColorValue": 0,
"ColumnName": "Case ID | Case Status",
"ColumnValue": "21140 | Closed",
"SortIndex": 0
},
{
"CaseQuestionTypeId": 100,
"ColumnColorValue": 0,
"ColumnName": "First Name:",
"ColumnValue": "",
"SortIndex": 1
},
{
"CaseQuestionTypeId": 100,
"ColumnColorValue": 0,
"ColumnName": "Last Name:",
"ColumnValue": "",
"SortIndex": 2
},
{
"CaseQuestionTypeId": 100,
"ColumnColorValue": 0,
"ColumnName": "What is your favorite Taco?",
"ColumnValue": "",
"SortIndex": 3
},
{
"CaseQuestionTypeId": 0,
"ColumnColorValue": 0,
"ColumnName": "",
"ColumnValue": "",
"SortIndex": 4
}
],
"IsActionPlan": false,
"NewMessageCount": 0,
"RespondentId": 119194,
"SortIndex": 0,
"StatusName": "Closed"
}
],
"TotalNewCaseCount": 61,
"TotalNewMessageCount": 0
},
"statusMessage": "Successful"
}
}
Error Response
HTTP Status Code: 400
{
"getMobileCaseInboxItemsResult":{
"statusMessage":" GUID format error:
Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"getMobileCaseInboxItemsResult":{
"statusMessage":"An error occurred logging out.
Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"getMobileCaseInboxItemsResult":{
"caseView":null,
"statusMessage":"Error: Not logged in or unauthorized.",
"viewValues":null
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
On the first column we combine 2 items (Case ID and Case Status) and with the Case Messaging there is a possibility of a 3rd item called New Messages. This new item will only be sent if showing “Cases”. If showing Action Plans, it will be omitted.
There is also a new property called “TotalNewMessageCount”. This new property resides in the caseMobileInboxData data structure.
POST getUserList
Retrieves the entire list of users.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
searchTerm=[string] Required
Does a “contains” search on the user’s full name. It first searches both First and Last Name; if neither exist then it searches username. Defaults to “” (empty string).
caseSensitiveSearch=[boolean] Optional
Indicates whether or not the search is case-sensitive. Defaults to false.
startPage=[int] Optional
Paging starts at 0, then increments up from there. Defaults to 0.
pageSize=[int] Optional
The number of items to return. Defaults to 100,000.
Sample Request
{
"token":"d1f70c0c-d432-4f00-8759-7ff641d8e85e",
"searchTerm":"Adam",
"caseSensitiveSearch":"false",
"startPage":0,
"pageSize":4
}
Response Values
GetUserListResult=[array]
Top-level response object returned by this endpoint, composed of the following elements:
statusMessage=[string]
Value that indicates the result of the getUserList request. Possible values are 1) “Successful” – Successful retrieval of user list, accompanied by an HTTP status code of 200; and 2) Error Message.
totalSearchCount=[int]
Total number of items returned with the search term and search type specified.
Array of user objects.
Sample Response
{
"GetUserListResult": {
"statusMessage": "Successful",
"totalSearchCount": 2,
"userAccount": [
{
"FirstName": "John",
"FullName": "John Public",
"LastName": "Public",
"UserId": "86172899-b83e-4946-ac14-0055b610c2f9",
"UserName": "john.public@email.com"
},
{
"FirstName": "Jane",
"FullName": "Jane Public",
"LastName": "Public",
"UserId": "a04ba199-1db3-4b78-bec8-14957b1ae29f",
"UserName": "janepublic@email.com"
}
]
}
}
Error Response
HTTP Status Code: 400
{
"GetUserListResult":{
"statusMessage":" GUID format error:
Guid should contain 32 digits with 4 dashes
(xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"GetUserListResult":{
"statusMessage":"An error occurred logging out.
Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"GetUserListResult":{
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST insertCaseHistory
The case history is a record of actions performed by system users on a particular case. insertCaseHistory creates an entry into that table.
Most changes are recorded automatically when case details are changed. However, there are times when it is necessary to add an audit trail for other actions. For instance, in the case of mobile applications a caseworker may have email and phone contact with the original survey respondent.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
historyChangeType=[int] Required
Represents the History value to insert, see historyChangeType.
caseId=[int] Required
Identifier of the case to tie the change to, retrieved by the endpoint getMobileCaseInboxItems.
previousText=[string] Optional
The previous text that was entered; defaults to null.
changedText=[string] Optional
The new text that has been entered; email or phone number that is used to contact the case subject. Defaults to null.
previousInt=[int] Optional
The previous integer value; defaults to null.
changeInt=[int] Optional
The new integer value; defaults to null.
changedBit=[boolean] Optional
The new boolean value; defaults to null.
Sample Request
{
"token":"d1f70c0c-d432-4f00-8759-7ff641d8e85e",
"historyChangeType":2000,
"caseId":1
}
Response Values
InsertCaseHistoryResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the insertCaseHistory request. Possible values are 1) Successful – Successful insertion of entry into case history table, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"InsertCaseHistoryResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"InsertCaseHistoryResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"InsertCaseHistoryResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"InsertCaseHistoryResult":{
"caseView":null,
"statusMessage":"Error: Not logged in or unauthorized.",
"viewValues":null
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 400
{
"InsertCaseHistoryResult":{
"statusMessage":"Invalid caseid, must be a positive number. caseid passed: 0"
}
}
HTTP Status Code: 400
{
"InsertCaseHistoryResult":{
"statusMessage":"Invalid History Change Type"
}
}
HTTP Status Code: 400
{
"InsertCaseHistoryResult":{
"statusMessage":"Mobile Change type need to include email or phone number in the changeText field"
}
}
Sample Call
TBD
Notes
POST insertUpdateActivityNote
Adds or updates a case activity note.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseActivityNoteId=[int] Required
The ID of the activity note being updated. Use 0 for a new activity note.
caseId=[int] Required
The ID of the case that the note is added to, retrieved by the endpoint getMobileCaseInboxItems.
noteText=[string] Required
Text of the note to insert/update.
Sample Request
{
"token":"65356038-05d8-435d-9c36-209b8c9d3eb9",
"caseActivityNoteId":0, // 0 = new
"caseId":9,
"noteText":"Note text goes here"
}
Response Values
InsertUpdateActivityNoteResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
Result of the request to add or update a case activity note. Possible Values are 1) “Successful” – The request succeeded, accompanied by an HTTP status code of 200; and 2) Error Message.
caseActivityNote=[string]
The new or updated activity note object in JSON format.
Sample Response
{
"InsertUpdateActivityNoteResult":{
"caseActivityNote":{
"ActivityNote":"Yet another test",
"ActivityNoteDate":"\/Date(1422568323253-0700)\/",
"ActivityNoteDateFormatted":"Jan 29, 2015 02:52 PM",
"CaseActivityNoteId":82,
"CaseId":9,
"FirstName":"Steve",
"FullName":"Steve Richins",
"HashCode":"D4F6F4F6F50848C8A6200ABCFE052354B8800292",
"LastName":"Richins",
"NoteFile":null,
"UserId":"7aad3157-b923-42e8-be63-f949cd756913"
},
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"insertUpdateActivityNoteResult":{
"statusMessage":" GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"insertUpdateActivityNoteResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"insertUpdateActivityNoteResult":{
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 404
Not found errors.
HTTP Status Code: 500
Internal server errors.
Sample Call
TBD
Notes
POST insertUpdateDeviceID
Creates or updates a mobile device ID and ties this to a specific MaritzCX user.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
deviceRegistrationToken=[string] Required
Device registration token that comes from the mobile device of the customer; consists of a string up to 4096 characters.
applicationTypeId=[int] Required
Specifies the component of the MaritzCX platform for which a mobile device ID is being created or updated. The possible value is 1 = CaseManagement. At this time only CaseManagement is possible; in the future other components of the platform will also be available to mobile devices.
deviceTypeId=[int] Required
Specifies the device platform for which a mobile device ID is being created or updated. Possible values are 1 = iOS, 2 = Android.
Sample Request
{
"token":"11111111-1111-1111-1111-111111111111",
"deviceRegistrationToken":"123456789",
"applicationTypeId":1,
"deviceTypeId":1
}
Response Values
InsertUpdateDeviceIdResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the creation or update request. Possible values are 1) “Successful” – the request succeeded; accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 503 Service Unavailable
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"A mobile user wasn't created or didn't exist in the database"
}
}
Note: This error is likely the result of a database connection failure.
HTTP Status Code: 400
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"Mobile Application Type ID is invalid"
}
}
HTTP Status Code: 400
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"Mobile Device Type ID is invalid"
}
}
HTTP Status Code: 500
{
"InsertUpdateDeviceIdResult":{
"statusMessage":"Internal error: + [additional error message from server]"
}
}
Sample Call
TBD
Notes
POST logout
Signs the user out of the application interface.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
Sample Request
{
"token":"session_token"
}
Response Values
LogoutResult=[array]
Top-level response object returned by this endpoint, containing the following element:
statusMessage=[string]
Result of the logout request. Possible Values are 1) Successful – Successful logout, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"LogoutResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"LogoutResult":{
"statusMessage":"An error occurred logging out. Error Message: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"LogoutResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: N/A
{
"LogoutResult":{
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST markMessagesRead
Marks an array of messages as read.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseMessageIds=[array of integers] Required
Array of Case Message IDs that need to be marked as read.
Sample Request
{"token":"65356038-05d8-9c26-209b8c9d3eb9", "caseMessageIds":[2,3,4,5]}
Response Values
MarkMessagesReadResult=[array]
Top-level response object returned by this endpoint, containing the following element:
statusMessage=[string]
Value that indicates the result of the request to get all messages. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"MarkMessagesReadResult": {
"statusMessage":"Successful",
}
}
Error Response
HTTP Status Code: 403
Not logged in or unauthorized
Need to log in using the authenticate endpoint.
HTTP Status Code: 400
Guid should contain 32
Improperly formatted authentication token was passed to the API.
HTTP Status Code: 400
Missing or empty token
Authentication token is missing and must be passed.
HTTP Status Code: 400
caseMessageIds array length must be greater than 0
No CaseMessageIDs were sent in the request.
HTTP Status Code: 500
Internal Error (with text reason)
Cause of the internal error, usually passing invalid data or an internal fault. If it persists please contact technical support.
Sample Call
TBD
Notes
POST removeDeviceID
Removes a mobile device from the MaritzCX registry.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
deviceRegistrationToken=[string] Required
Consists of a string up to 4096 characters.
applicationTypeId=[int] Required
Specifies the component of the MaritzCX platform for which a mobile device ID is being removed. The possible value is 1 = CaseManagement. At this time only CaseManagement is possible; in the future other components of the platform will also be available to mobile devices.
Sample Request
{
"token":"11111111-1111-1111-1111-111111111111",
"deviceRegistrationToken":"123456789",
"applicationTypeId":1
}
Response Values
RemoveDeviceIdResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the device removal request. Possible Values are 1) “Successful” – The request succeeded, accompanied by an HTTP status code of 200; 2) “Mobile Device Type ID is invalid” – The deviceTypeId that was passed in is not recognized; and 3) Other error message.
Sample Response
{
"RemoveDeviceIdResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"RemoveDeviceIdResult":{
"statusMessage":" GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"RemoveDeviceIdResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"RemoveDeviceIdResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 400
{
"RemoveDeviceIdResult":{
"statusMessage":"The device registration token is not in the database"
}
}
The deviceRegistrationToken that was passed in is not in the database.
HTTP Status Code: 400
{
"RemoveDeviceIdResult":{
"statusMessage":"Mobile Application Type ID is invalid"
}
}
The applicationTypeId that was passed in is not recognized.
HTTP Status Code: 500
{
"RemoveDeviceIdResult":{
"statusMessage":"Internal error: + [additional error message from server]"
}
}
Sample Call
TBD
Notes
POST reprocessRespondentIDs
Sets the “do not send alert” value to false and sets up a list of respondents that will be reprocessed in the system.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
A comma-separated list of Respondent IDs for which you want to set the “do not send alert” value and reprocess case creation. Will default to an empty string.
Only integer values or a comma are allowed in the string. The string must begin and end with an integer value. You can specify up to 10000 respondent IDs in a single call.
Example – “1234,1235,1236,1237,1238,1239,1567,1568,1569”
startRespondentId=[int] Required
The integer value of the RespondentID you want to begin with.
endRespondentId=[int] Required
The integer value of the RespondentID you want to end with.
Sample Request
{"token": "e7bbd5c3-be29-4d53-8b2a-4dc78be4d104",
"respondentIds":"1234,1235,1236,1237,1238,1239,1567,1568,1569",
"startRespondentId":"",
"endRespondentId":""
}
Response Values
ReprocessRespondentIDsResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
Value that indicates the result of the request to set the “do not send alert” value and reprocess case creation. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) error message.
Sample Response
{
"ReprocessRespondentIDsResult": "Reprocess Respondent IDs Initiated"
}
Error Response
HTTP Status Code: 400
{
"ReprocessRespondentIDsResult":{
"statusMessage":" GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"ReprocessRespondentIDsResult": "Invalid respondent ids request: respondentIds value has more than 10000 numbers in it"
}
There are more than 10000 respondent IDs.
HTTP Status Code: 400
{
"ReprocessRespondentIDsResult": "Invalid respondent ids request: respondentIds value is not formatted properly, can only contain integer values separated by commas"
}
Invalid respondent ids request: respondentIds value is not formatted properly; it can only contain integer values separated by commas.
HTTP Status Code: 400
{
"ReprocessRespondentIDsResult": "Invalid startRespondentId request: startRespondentId value can only be an integer value"
}
Invalid startRespondentId request: startRespondentId value can only be an integer value.
HTTP Status Code: 400
{
"ReprocessRespondentIDsResult": "Invalid endRespondentId request: endRespondentId value can only be an integer value"
}
Invalid endRespondentId request: endRespondentId value can only be an integer value.
HTTP Status Code: 403
{
"ReprocessRespondentIDsResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
An invalid or expired token was passed in.
HTTP Status Code: 403
{
"ReprocessRespondentIDsResult": {
"statusMessage": "Error: User Doesn't Have Access To Reprocess Respondents"
}
}
The logged-in user doesn’t have case program admin privilege, which is necessary to reprocess respondents.
Sample Call
TBD
Notes
Also, the following limits are enforced:
- You can specify up to 10000 respondent IDs in a single call.
POST setDoNotSendAlert
Sets the “do not send alert” value on a specified list of respondents in the system.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
respondentIds=[string] Required
A comma-separated list of Respondent IDs for which you want to set the “do not send alert” value. Will default to an empty string.
Only integer values or a comma are allowed in the string. The string must begin and end with an integer value. You can specify up to 10000 respondent IDs in a single call.
Example – “1234,1235,1236,1237,1238,1239,1567,1568,1569”
startRespondentId=[int] Required
The integer value of the RespondentID you want to begin with.
endRespondentId=[int] Required
The integer value of the RespondentID you want to end with.
doNotSendAlertValue=[string] Required
Specifies whether you are setting the do not send alert value to on (1) or off (0).
Sample Request
{"token": "e7bbd5c3-be29-4d53-8b2a-4dc78be4d104",
"respondentIds":"1234,1235,1236,1237,1238,1239,1567,1568,1569",
"startRespondentId":"",
"endRespondentId":"",
"doNotSendAlertValue":"1"
}
Response Values
SetDoNotSendAlertResult=[array]
Top-level response object returned by this endpoint, composed of the following elements:
statusMessage=[string]
Value that indicates the result of the request to set the “do not send alert” value. The possible values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; and 2) error message.
Sample Response
{
"SetDoNotSendAlertResult": "DoNotSendAlert Value Set"
}
Error Response
HTTP Status Code: 400
{
"SetDoNotSendAlertResult":{
"statusMessage":" GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"SetDoNotSendAlertResult": "Invalid respondent ids request: respondentIds value has more than 10000 numbers in it"
}
There are more than 10000 respondent IDs.
HTTP Status Code: 400
{
"SetDoNotSendAlertResult": "Invalid respondent ids request: respondentIds value is not formatted properly, can only contain integer values separated by commas"
}
Invalid respondent ids request: respondentIds value is not formatted properly; it can only contain integer values separated by commas.
HTTP Status Code: 400
{
"SetDoNotSendAlertResult": "Invalid startRespondentId request: startRespondentId value can only be an integer value"
}
Invalid startRespondentId request: startRespondentId value can only be an integer value.
HTTP Status Code: 400
{
"SetDoNotSendAlertResult": "Invalid endRespondentId request: endRespondentId value can only be an integer value"
}
Invalid endRespondentId request: endRespondentId value can only be an integer value.
HTTP Status Code: 400
{
"SetDoNotSendAlertResult": "Invalid doNotSendAlertValue request: doNotSendAlertValue can only be a 0 or 1"
}
Invalid doNotSendAlertValue request: doNotSendAlertValue can only be a 0 or 1.
HTTP Status Code: 403
{
"SetDoNotSendAlertResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
An invalid or expired token was passed in.
HTTP Status Code: 403
{
"SetDoNotSendAlertResult": {
"statusMessage": "Error: User Doesn't Have Access To Set the Do Not Send Alert Value" }
}
The logged-in user doesn’t have case program admin privilege, which is necessary to set the do not send alert value.
Sample Call
TBD
Notes
Also, the following limits are enforced:
- You can specify up to 10000 respondent IDs in a single call.
POST setMobileNotificationMode
Sets the mobile notification mode.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
mobileNotificationMode=[int] Required
Description. Possible values are: 0 = No Notification; 1 = New Case Status; 2 = New Messages; 3 = Both New Case Status and New Message.
Sample Request
{"token":"65356038-05d8-9c26-209b8c9d3eb9", "mobileNotificationMode":1}
Response Values
setMobileNotificationModeResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the getCaseStatistics request. Possible values are 1) Successful – Successful retrieval of the user list, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"setMobileNotificationModeResult": {
"statusMessage":"Successful",
}
}
Error Response
HTTP Status Code: 403
Not logged in or unauthorized
Need to log in using the authenticate endpoint.
HTTP Status Code: 400
Guid should contain 32
Improperly formatted authentication token was passed to the API.
HTTP Status Code: 400
Missing or empty token
Authentication token is missing and must be passed.
HTTP Status Code: 500
Internal Error (with text reason)
Cause of the internal error, usually passing invalid data or an internal fault. If it persists please contact technical support.
Sample Call
TBD
Notes
POST updateCaseOwner
Changes the case owner.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
The ID of the case that is being updated, retrieved by the endpoint getMobileCaseInboxItems.
prevUserId=[GUID] Required
The GUID of the previous owner of the case.
newUserId=[GUID] Required
The GUID of the new owner of the case.
messageToNewOwner=[string] Required
String of information that is sent in the email to the new owner.
Sample Request
{
"token":"11111111-1111-1111-1111-111111111111",
"caseId":1,
"prevUserId":"22222222-2222-2222-2222-222222222222",
"newUserId":"33333333-3333-3333-3333-333333333333",
"messageToNewOwner":"You are being assigned as the new owner of this case.
Please review and take appropriate action."
}
Response Values
UpdateCaseOwnerResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the case ownership change request. Possible values are 1) “Successful” – The request succeeded, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"UpdateCaseOwnerResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"updateCaseOwnerResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"updateCaseOwnerResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"UpdateCaseOwnerResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"Case id doesn't exist in the system"
}
}
The case ID is not in the system.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"Case is not owned by the previous user"
}
}
The case is not owned by the previous user.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"Previous user doesn't exist in the system"
}
}
The previous user is not found in the system.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"New user doesn't exist in the system"
}
}
The new user is not found in the system.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"New user is inactive in the system"
}
}
The new user is inactive in the system.
HTTP Status Code: 400
{
"UpdateCaseOwnerResult":{
"statusMessage":"New user is locked out of the system"
}
}
The new user has been locked out of the system.
HTTP Status Code: 500
{
"UpdateCaseOwnerResult":{
"statusMessage":"Internal error: + [additional error message from server]"
}
}
The new user is inactive in the system.
Sample Call
TBD
Notes
POST updateCaseTimeOffset
Adds a time offset to a case in order to account for holidays in elapsed timer functionality; specifically adds the Elapsed Time to Respond and Elapsed Time to Close counters.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
timeOffsetSeconds=[long] Required
The time offset to apply to the case; one day = 86400 seconds.
caseIds=[string] Required
Comma-separated case IDs to apply, passed in offset.
Sample Request
{"token": "67577993-5915-48dd-8c84-d0326005c6f7",
"timeOffsetSeconds": 86400,
"caseIds":"8059,7864"
}
Response Values
UpdateCaseTimeOffsetResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
The result of the case ownership change request. Possible values are 1) “Successful” – The request succeeded, accompanied by an HTTP status code of 200; and 2) Error Message.
Sample Response
{
"UpdateCaseTimeOffsetResult":
{
“statusMessage”: “Successful”
}
}
Error Response
HTTP Status Code: 400
{
"UpdateCaseTimeOffsetResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"UpdateCaseTimeOffsetResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"UpdateCaseTimeOffsetResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 403
{
"UpdateCaseTimeOffsetResult": {
"statusMessage": "User does not have permissions to perform this operation"
}
}
The user does not have permission to perform the update.
HTTP Status Code: 400
{
"UpdateCaseTimeOffsetResult": {
"statusMessage": "Input string was not in a correct format"
}
}
The CaseID was formatted incorrectly.
Sample Call
TBD
Notes
- User performing update must have Case Program Admin permission.
- Time Offset is not additive. The value passed will replace the current value.
- Time Offset will only effect current running timers. For instance, if Time to Respond has already occured the time offset value will not affact it. Same logic applies to Time to Close.
- Time Offset should be a positive value and will be subtracted to the current running timers.
POST updateCaseView
Updates the case detail’s answer values. Only ItemAnswers, RootCauses, DropDowns, Case Status, and Case Priority can be updated though this endpoint.
ItemsAnswers will update the following Case Form controls:
- Short Text Values
- Long Text Values
- Numeric
- Date Picker
- Dropdowns
RootCauseAnswers are a collection of answers for Root Causes.
To update the Case Status and Priority, update the CaseStatusId and CasePriorityId respectively with the appropriate ID. These values are retrieved from getCaseView.caseView.CaseStatusId. Both Priority and Status use the same Id values.
The priorities are in the following order:
- High
- Medium
- Low
The statuses are in the following order:
- New
- In Progress
- Closed
Note: Owner, watchers, and activity notes need to be updated through their respective endpoints:
- Owner – updateCaseOwner
- Watchers – updateCaseWatcher
- insert/update Activity Note – insertUpdateActvityNote
- delete Activity Note – deleteActivityNote
All other properties are read-only and will not be updated.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
oldCaseViewValues Required
Complex parent element; values that compose the Case View prior to their being updated. Identical to the elements that form viewValues.
newCaseViewValues Required
Complex parent element; same as oldCaseViewValues, but with values updated. Also identical to the elements that form viewValues.
Sample Request
{
"token":"d841e519-9f3f-4943-8da5-d1c152bd43a6",
"oldCaseViewValues":{
"ActivityNotes":[
{
"ActivityNote":"Another Note",
"ActivityNoteDate":"\/Date(1416501309227-0500)\/",
"ActivityNoteDateFormatted":"Nov 20, 2014 11:35 AM",
"CaseActivityNoteId":2,
"CaseId":2,
"FirstName":"Inquisite",
"FullName":"Inquisite Administrator",
"HashCode":"9BCED8A556A5AFC93CFFA1AB8C1E3F391279A21A",
"LastName":"Administrator",
"NoteFile":null,
"UserId":"23764c18-e7cc-4649-a380-0affab0e838a"
},
{
"ActivityNote":"A note",
"ActivityNoteDate":"\/Date(1416501302247-0500)\/",
"ActivityNoteDateFormatted":"Nov 20, 2014 11:35 AM",
"CaseActivityNoteId":1,
"CaseId":2,
"FirstName":"Inquisite",
"FullName":"Inquisite Administrator",
"HashCode":"CEAE9C75C3ABD6EB7F0502006A10CE37E751A742",
"LastName":"Administrator",
"NoteFile":null,
"UserId":"23764c18-e7cc-4649-a380-0affab0e838a"
}
],
"AlertName":"New Alert Name",
"CaseId":2,
"CasePriorityId":0,
"CaseRootCauseIds":[
176,
177,
178
],
"CaseStatusId":0,
"CurrentUserId":"00000000-0000-0000-0000-000000000000",
"DateClosed":"\/Date(-62135578800000-0500)\/",
"DateClosedFormatted":"",
"DateSubmitted":"\/Date(1412203893967-0400)\/",
"DateSubmittedFormatted":"Oct 01, 2014 06:51 PM",
"FirstName":"Inquisite",
"ItemAnswers":[
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":2,
"CaseItemId":3,
"CaseQuestionTypeId":11,
"IntValue":0,
"TextValue":"A value for something would go here…"
},
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":3,
"CaseItemId":21,
"CaseQuestionTypeId":12,
"IntValue":0,
"TextValue":"Thought I’d give you all a heads up re Breville.
I bought a BOV650XL 15 mos. ago and started getting the EO5 error
message that requires you to contact Breville. Long story short their
message to me was that since I’d bought the toaster oven online
through a secondary seller and not thru an authorized dealer they would
NOT honor the warranty. They did not disagree that they had a
reoccurring problem with their oven [which has been documented thru
others experience with the same oven].I had ask for a variance to the
1 year waiver citing the reoccurring problem. They didn’t disagree,
but gave the excuse above for not taking any action.My days of shopping
for the best price online are over. I’ll only buy from a name brand
store online from now on."
},
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":4,
"CaseItemId":18,
"CaseQuestionTypeId":13,
"IntValue":9,
"TextValue":null
}
],
"LastName":"Administrator",
"OwnerUserId":"23764c18-e7cc-4649-a380-0affab0e838a",
"ProgramName":"MLK 9\/30 Test 4",
"RespondentId":2840331,
"SourceName":"",
"SourceValues":[
],
"SurveyName":"2010 Radio Show Exhibitor Survey",
"TimeToClose":0,
"TimeToCloseColor":0,
"TimeToCloseDays":0,
"TimeToCloseDisplay":"118d 22h",
"TimeToCloseGoal":0,
"TimeToCloseGoalDays":0,
"TimeToCloseGoalDisplay":"",
"TimeToCloseGoalHours":0,
"TimeToCloseHours":0,
"TimeToRespond":4216312,
"TimeToRespondColor":0,
"TimeToRespondDays":48,
"TimeToRespondDisplay":"48d 19h",
"TimeToRespondGoal":0,
"TimeToRespondGoalDays":0,
"TimeToRespondGoalDisplay":"",
"TimeToRespondGoalHours":0,
"TimeToRespondHours":19,
"WatcherType":1
},
"newCaseViewValues":{
"ActivityNotes":[
{
"ActivityNote":"Another Note",
"ActivityNoteDate":"\/Date(1416501309227-0500)\/",
"ActivityNoteDateFormatted":"Nov 20, 2014 11:35 AM",
"CaseActivityNoteId":2,
"CaseId":2,
"FirstName":"Inquisite",
"FullName":"Inquisite Administrator",
"HashCode":"9BCED8A556A5AFC93CFFA1AB8C1E3F391279A21A",
"LastName":"Administrator",
"NoteFile":null,
"UserId":"23764c18-e7cc-4649-a380-0affab0e838a"
},
{
"ActivityNote":"A note",
"ActivityNoteDate":"\/Date(1416501302247-0500)\/",
"ActivityNoteDateFormatted":"Nov 20, 2014 11:35 AM",
"CaseActivityNoteId":1,
"CaseId":2,
"FirstName":"Inquisite",
"FullName":"Inquisite Administrator",
"HashCode":"CEAE9C75C3ABD6EB7F0502006A10CE37E751A742",
"LastName":"Administrator",
"NoteFile":null,
"UserId":"23764c18-e7cc-4649-a380-0affab0e838a"
}
],
"AlertName":"New Alert Name",
"CaseId":2,
"CasePriorityId":0,
"CaseRootCauseIds":[
176,
177,
178
],
"CaseStatusId":0,
"CurrentUserId":"00000000-0000-0000-0000-000000000000",
"DateClosed":"\/Date(-62135578800000-0500)\/",
"DateClosedFormatted":"",
"DateSubmitted":"\/Date(1412203893967-0400)\/",
"DateSubmittedFormatted":"Oct 01, 2014 06:51 PM",
"FirstName":"Inquisite",
"ItemAnswers":[
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":2,
"CaseItemId":3,
"CaseQuestionTypeId":11,
"IntValue":0,
"TextValue":"More Changes - A value for something would go here…"
},
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":3,
"CaseItemId":21,
"CaseQuestionTypeId":12,
"IntValue":0,
"TextValue":" Some text changes: Thought I’d give you all a heads up re Breville.
I bought a BOV650XL 15 mos. ago and started getting the EO5 error
message that requires you to contact Breville. Long story short their
message to me was that since I’d bought the toaster oven online
through a secondary seller and not thru an authorized dealer they would
NOT honor the warranty. They did not disagree that they had a
reoccurring problem with their oven [which has been documented thru
others experience with the same oven].I had ask for a variance to the
1 year waiver citing the reoccurring problem. They didn’t disagree,
but gave the excuse above for not taking any action.My days of shopping
for the best price online are over. I’ll only buy from a name brand
store online from now on."
},
{
"BoolValue":false,
"CaseId":2,
"CaseItemAnswerId":4,
"CaseItemId":18,
"CaseQuestionTypeId":13,
"IntValue":8,
"TextValue":null
}
],
"LastName":"Administrator",
"OwnerUserId":"23764c18-e7cc-4649-a380-0affab0e838a",
"ProgramName":"MLK 9\/30 Test 4",
"RespondentId":2840331,
"SourceName":"",
"SourceValues":[
],
"SurveyName":"2010 Radio Show Exhibitor Survey",
"TimeToClose":0,
"TimeToCloseColor":0,
"TimeToCloseDays":0,
"TimeToCloseDisplay":"118d 22h",
"TimeToCloseGoal":0,
"TimeToCloseGoalDays":0,
"TimeToCloseGoalDisplay":"",
"TimeToCloseGoalHours":0,
"TimeToCloseHours":0,
"TimeToRespond":4216312,
"TimeToRespondColor":0,
"TimeToRespondDays":48,
"TimeToRespondDisplay":"48d 19h",
"TimeToRespondGoal":0,
"TimeToRespondGoalDays":0,
"TimeToRespondGoalDisplay":"",
"TimeToRespondGoalHours":0,
"TimeToRespondHours":19,
"WatcherType":1
}
}
Response Values
UpdateCaseViewResult=[array]
Complex top-level response object returned by this endpoint. Composed of the following children:
caseView=[array]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
statusMessage=[string]
Value that indicates the result of the Case View update attempt. Possible values are 1) “Successful” – Case View was updated successfully, accompanied by an HTTP status code of 200; and 2) Error Message.
viewValues=[array]
Complex second-level response object returned by this endpoint. Contains numerous children, detailed in the Appendix.
caseOwnerEnabled=[bool]
Value that indicates whether or not the owner is able to modify the case; true = able to modify, false = not able to modify.
messagingEnabled=[bool]
Value that indicates whether or not messaging is enabled; true = case messaging is enabled, false = not enabled.
viewAddWatchersEnabled=[bool]
Value that indicates whether or not watchers are able to modify cases; true = watchers are able to modify cases, false = they are not able to modify cases.
Sample Response
{
"UpdateCaseViewResult": {
"caseOwnerEnabled": true,
"caseView": {
"CaseCanvasSettings": "{\"height\":\"11in\",\"width\":\"754px\",\"showGrid\":true,\"showPageBreaks\":false,\"paperSize\":\"letter\"}",
"CaseStatusIds": [
1,
2,
3
],
"CaseViewItems": [
{
"CaseId": 8141,
"CaseItemId": 2997,
"CaseItemText": "Time to respond",
"CaseProgramId": 82,
"CaseQuestionTypeId": 18,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":60,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":0,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2997",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 0,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 2998,
"CaseItemText": "Time to close",
"CaseProgramId": 82,
"CaseQuestionTypeId": 19,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"\",\"required\":\"\",\"top\":60,\"left\":360,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":1,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2998",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 1,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 2999,
"CaseItemText": "<p><span style=\"font-size:24px\"><span style=\"color:rgb(169, 169, 169)\"><span style=\"font-family:verdana,geneva,sans-serif\">CASE INFORMATION</span></span></span></p>%0",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CASE INFORMATION%0\",\"required\":\"\",\"top\":180,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":2,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text2999",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 2,
"mobileText": "<p><span><span><span>CASE INFORMATION</span></span></span></p>%0",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3000,
"CaseItemText": "I&amp;D:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 1,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"I&amp;D:\",\"required\":\"\",\"top\":240,\"left\":30,\"width\":330,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":3,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3000",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 3,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3001,
"CaseItemText": "CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 3,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CREATED:\",\"required\":\"\",\"top\":300,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":4,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3001",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 4,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3002,
"CaseItemText": "CLOSED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 16,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CLOSED:\",\"required\":\"\",\"top\":360,\"left\":30,\"width\":330,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":5,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3002",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 5,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3003,
"CaseItemText": "OWNER",
"CaseProgramId": 82,
"CaseQuestionTypeId": 9,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OWNER\",\"required\":\"\",\"top\":420,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":6,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3003",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 6,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3004,
"CaseItemText": "PRIORITY",
"CaseProgramId": 82,
"CaseQuestionTypeId": 5,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": -1,
"LocalizedLabel": null,
"Text": ""
},
{
"Id": 0,
"LocalizedLabel": "shared.noneSelected",
"Text": "None Selected"
},
{
"Id": 1,
"LocalizedLabel": "shared.high",
"Text": "High"
},
{
"Id": 2,
"LocalizedLabel": "shared.medium",
"Text": "Medium"
},
{
"Id": 3,
"LocalizedLabel": "shared.low",
"Text": "Low"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"PRIORITY\",\"required\":\"\",\"top\":510,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":7,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3004",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 7,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3005,
"CaseItemText": "<p><span style=\"font-size:24px\"><span style=\"color:rgb(169, 169, 169)\"><span style=\"font-family:verdana,geneva,sans-serif\">CUSTOMER INFORMATION</span></span></span></p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CUSTOMER INFORMATION\\n\",\"required\":\"\",\"top\":180,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECUSTOMER%20INFORMATION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":8,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3005",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 8,
"mobileText": "<p><span><span><span>CUSTOMER INFORMATION</span></span></span></p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3006,
"CaseItemText": "<p><span style=\"color:#B22222\"><span style=\"font-size:12px\"><span style=\"font-family:arial,helvetica,sans-serif\">{Replace this Text control with survey Data References containing<br />\ninformation such as customer name and contact details}</span></span></span><br />\n </p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"{Replace this Text control with survey Data References containing\\ninformation such as customer name and contact details}\\n \\n\",\"required\":\"\",\"top\":240,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Ainformation%20such%20as%20customer%20name%20and%20contact%20details%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":9,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3006",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 9,
"mobileText": "<p><span><span><span>{Replace this Text control with survey Data References containing<br>\ninformation such as customer name and contact details}</span></span></span><br>\n </p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3007,
"CaseItemText": "<p><span style=\"font-size:24px\"><span style=\"color:rgb(169, 169, 169)\"><span style=\"font-family:verdana,geneva,sans-serif\">RESPONSE SUMMARY</span></span></span></p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"RESPONSE SUMMARY\\n\",\"required\":\"\",\"top\":360,\"left\":390,\"width\":360,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ERESPONSE%20SUMMARY%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":10,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3007",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 10,
"mobileText": "<p><span><span><span>RESPONSE SUMMARY</span></span></span></p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3008,
"CaseItemText": "SURVEY TAKEN:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 17,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"SURVEY TAKEN:\",\"required\":\"\",\"top\":420,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":11,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3008",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 11,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3009,
"CaseItemText": "ALERT CREATED:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 10,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"verdana\",\"contentFontSize\":\"16px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ALERT CREATED:\",\"required\":\"\",\"top\":480,\"left\":390,\"width\":360,\"height\":120,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":12,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3009",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 12,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3010,
"CaseItemText": "<p><span style=\"color:#B22222\"><span style=\"font-size:12px\"><span style=\"font-family:arial,helvetica,sans-serif\">{Replace this Text control with survey Data References containing<br />\nrelevant survey response excerpts such as overall satisfaction or<br />\nlikelihood to recommend}</span></span></span><br />\n </p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"{Replace this Text control with survey Data References containing\\nrelevant survey response excerpts such as overall satisfaction or\\nlikelihood to recommend}\\n \\n\",\"required\":\"\",\"top\":540,\"left\":390,\"width\":360,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22color%3A%23B22222%22%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Aarial%2Chelvetica%2Csans-serif%22%3E%7BReplace%20this%20Text%20control%20with%20survey%20Data%20References%20containing%3Cbr%20%2F%3E%0Arelevant%20survey%20response%20excerpts%20such%20as%20overall%20satisfaction%20or%3Cbr%20%2F%3E%0Alikelihood%20to%20recommend%7D%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3Cbr%20%2F%3E%0A%26nbsp%3B%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":13,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3010",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 13,
"mobileText": "<p><span><span><span>{Replace this Text control with survey Data References containing<br>\nrelevant survey response excerpts such as overall satisfaction or<br>\nlikelihood to recommend}</span></span></span><br>\n </p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3011,
"CaseItemText": "<p><span style=\"font-size:24px\"><span style=\"color:rgb(169, 169, 169)\"><span style=\"font-family:verdana,geneva,sans-serif\">CASE ACTIVITY AND RESOLUTION</span></span></span></p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CASE ACTIVITY AND RESOLUTION\\n\",\"required\":\"\",\"top\":780,\"left\":30,\"width\":630,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cspan%20style%3D%22font-size%3A24px%22%3E%3Cspan%20style%3D%22color%3Argb(169%2C%20169%2C%20169)%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3ECASE%20ACTIVITY%20AND%20RESOLUTION%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":14,\"parentItemID\":-1,\"hasChildren\":true,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3011",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": true,
"mobileIndex": 14,
"mobileText": "<p><span><span><span>CASE ACTIVITY AND RESOLUTION</span></span></span></p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3012,
"CaseItemText": "CASE STATUS",
"CaseProgramId": 82,
"CaseQuestionTypeId": 4,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": 2,
"LocalizedLabel": "shared.inProgress",
"Text": "In Progress"
},
{
"Id": 3,
"LocalizedLabel": "shared.closed",
"Text": "Closed"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"CASE STATUS\",\"required\":\"\",\"top\":840,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":15,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3012",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 15,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3013,
"CaseItemText": "OUTCOME",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": [
651,
652,
653,
654
],
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": -1,
"LocalizedLabel": null,
"Text": "Select One"
},
{
"Id": 651,
"LocalizedLabel": null,
"Text": "Resolved"
},
{
"Id": 652,
"LocalizedLabel": null,
"Text": "Unable to contact"
},
{
"Id": 653,
"LocalizedLabel": null,
"Text": "Unresolved"
},
{
"Id": 654,
"LocalizedLabel": null,
"Text": "Other"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"OUTCOME\",\"required\":\"required\",\"top\":930,\"left\":30,\"width\":330,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":16,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3013",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 16,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3014,
"CaseItemText": "RESOLUTION DESCRIPTION",
"CaseProgramId": 82,
"CaseQuestionTypeId": 12,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"RESOLUTION DESCRIPTION\",\"required\":\"required\",\"top\":1410,\"left\":30,\"width\":330,\"height\":180,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":17,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3014",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 17,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3015,
"CaseItemText": "ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": [
"j7_1",
"j8_1",
"j8_2",
"j7_2",
"j8_3",
"j8_4",
"j8_5",
"j8_6",
"j8_7",
"j8_8",
"j3_1",
"j21_1"
],
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ROOT CAUSE\",\"required\":\"required\",\"top\":840,\"left\":390,\"width\":360,\"height\":240,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3015",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6348,
"ParentTreeId": "#",
"RootCauseName": "Root Cause2 & Section 1",
"SortPosition": 0,
"TreeId": "j7_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6669,
"ParentTreeId": "j7_1",
"RootCauseName": "A child 1",
"SortPosition": 1,
"TreeId": "j8_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6670,
"ParentTreeId": "j8_1",
"RootCauseName": "a sub child",
"SortPosition": 2,
"TreeId": "j8_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6351,
"ParentTreeId": "#",
"RootCauseName": "Root cause2 section 2",
"SortPosition": 3,
"TreeId": "j7_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6663,
"ParentTreeId": "j7_2",
"RootCauseName": "1",
"SortPosition": 4,
"TreeId": "j8_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6664,
"ParentTreeId": "j7_2",
"RootCauseName": "2",
"SortPosition": 5,
"TreeId": "j8_4"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6665,
"ParentTreeId": "j7_2",
"RootCauseName": "3",
"SortPosition": 6,
"TreeId": "j8_5"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6666,
"ParentTreeId": "j7_2",
"RootCauseName": "4",
"SortPosition": 7,
"TreeId": "j8_6"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6667,
"ParentTreeId": "j7_2",
"RootCauseName": "5",
"SortPosition": 8,
"TreeId": "j8_7"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6668,
"ParentTreeId": "j7_2",
"RootCauseName": "New node",
"SortPosition": 9,
"TreeId": "j8_8"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6540,
"ParentTreeId": "#",
"RootCauseName": "New root",
"SortPosition": 10,
"TreeId": "j3_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3015,
"CaseRootCauseId": 6561,
"ParentTreeId": "#",
"RootCauseName": "Another Node",
"SortPosition": 11,
"TreeId": "j21_1"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3716,
"CaseItemText": "Color ROOT CAUSE",
"CaseProgramId": 82,
"CaseQuestionTypeId": 6,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": [
"j11_1",
"j11_2",
"j11_3",
"j11_4"
],
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Color ROOT CAUSE\",\"required\":\"required\",\"top\":1110,\"left\":0,\"width\":390,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":18,\"parentItemID\":0,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": true,
"ResourceKey": "caseitem.text3716",
"RootCauseValues": [
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6578,
"ParentTreeId": "#",
"RootCauseName": "Colors",
"SortPosition": 0,
"TreeId": "j11_1"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6579,
"ParentTreeId": "j11_1",
"RootCauseName": "Red",
"SortPosition": 1,
"TreeId": "j11_2"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6580,
"ParentTreeId": "j11_1",
"RootCauseName": "Green",
"SortPosition": 2,
"TreeId": "j11_3"
},
{
"AllowOtherNode": false,
"CaseItemId": 3716,
"CaseRootCauseId": 6581,
"ParentTreeId": "j11_1",
"RootCauseName": "Blue",
"SortPosition": 3,
"TreeId": "j11_4"
}
],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 18,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3016,
"CaseItemText": "<p><em><span style=\"font-size:12px\"><span style=\"font-family:verdana,geneva,sans-serif\">Enter an activity note each time you work the case that describes the action taken.</span></span></em></p>\n",
"CaseProgramId": 82,
"CaseQuestionTypeId": 20,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Enter an activity note each time you work the case that describes the action taken.\\n\",\"required\":\"\",\"top\":1230,\"left\":30,\"width\":720,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":\"%3Cp%3E%3Cem%3E%3Cspan%20style%3D%22font-size%3A12px%22%3E%3Cspan%20style%3D%22font-family%3Averdana%2Cgeneva%2Csans-serif%22%3EEnter%20an%20activity%20note%20each%20time%20you%20work%20the%20case%20that%20describes%20the%20action%20taken.%3C%2Fspan%3E%3C%2Fspan%3E%3C%2Fem%3E%3C%2Fp%3E%0A\",\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":19,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3016",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 19,
"mobileText": "<p><em><span><span>Enter an activity note each time you work the case that describes the action taken.</span></span></em></p>",
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3017,
"CaseItemText": "ACTIVITY NOTES",
"CaseProgramId": 82,
"CaseQuestionTypeId": 7,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"verdana\",\"labelFontSize\":\"16px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"ACTIVITY NOTES\",\"required\":\"\",\"top\":1260,\"left\":30,\"width\":720,\"height\":150,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":20,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3017",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 20,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3172,
"CaseItemText": "View/Add Watchers:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 22,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#8cc652\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"View/Add Watchers:\",\"required\":\"\",\"top\":630,\"left\":30,\"width\":300,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":22,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3172",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 22,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3294,
"CaseItemText": "Case Program Name:",
"CaseProgramId": 82,
"CaseQuestionTypeId": 2,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Case Program Name:\",\"required\":\"\",\"top\":690,\"left\":30,\"width\":300,\"height\":30,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":23,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3294",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 23,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3447,
"CaseItemText": "Dropdown 2",
"CaseProgramId": 82,
"CaseQuestionTypeId": 13,
"DefaultDropdownValues": [
798,
799,
800
],
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [
{
"Id": -1,
"LocalizedLabel": null,
"Text": "Select One"
},
{
"Id": 798,
"LocalizedLabel": null,
"Text": "red"
},
{
"Id": 799,
"LocalizedLabel": null,
"Text": "blue"
},
{
"Id": 800,
"LocalizedLabel": null,
"Text": "white"
}
],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Dropdown 2\",\"required\":\"\",\"top\":1050,\"left\":30,\"width\":120,\"height\":60,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":24,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":false,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3447",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 24,
"mobileText": null,
"parentItemID": 0,
"showTimeField": false
},
{
"CaseId": 8141,
"CaseItemId": 3535,
"CaseItemText": "Date Picker",
"CaseProgramId": 82,
"CaseQuestionTypeId": 26,
"DefaultDropdownValues": null,
"DefaultHyperlinkText": null,
"DefaultHyperlinkUrl": null,
"DefaultRootCauseValues": null,
"DefaultValue": null,
"DefaultVisibilityTypeId": 1,
"DisplayRules": [],
"DropdownValues": [],
"FormatString": "{\"labelFontWeight\":400,\"labelFontStyle\":\"normal\",\"labelTextDecoration\":\"none\",\"labelFontFamily\":\"arial\",\"labelFontSize\":\"12px\",\"labelColor\":\"#000000\",\"contentFontWeight\":400,\"contentFontStyle\":\"normal\",\"contentTextDecoration\":\"none\",\"contentFontFamily\":\"arial\",\"contentFontSize\":\"12px\",\"contentColor\":\"#000000\",\"borderColor\":\"#000\",\"borderWidth\":\"1px\",\"borderStyle\":\"solid\",\"text\":\"Date Picker\",\"required\":\"\",\"top\":1140,\"left\":390,\"width\":390,\"height\":90,\"ffWidth\":null,\"ffHeight\":null,\"contentText\":null,\"allowother\":false,\"displayGoal\":true,\"mobileIndex\":25,\"parentItemID\":-1,\"hasChildren\":false,\"dataReferenceContactType\":\"0\",\"adminOnlyOwnershipChange\":false,\"showTimeField\":true,\"dataReferenceFormatType\":\"1\",\"filterUsers\":false,\"adminWatchers\":false,\"Version\":1}",
"HyperLinkResourceKey": "",
"HyperLinkUrlResourceKey": "",
"HyperlinkText": "",
"HyperlinkUrl": "",
"IsEmailAddress": false,
"IsPhoneNumber": false,
"NeededToClose": false,
"ResourceKey": "caseitem.text3535",
"RootCauseValues": [],
"SourceScaleId": 0,
"VisibilityTypeId": 1,
"isGroupParent": false,
"mobileIndex": 25,
"mobileText": null,
"parentItemID": 0,
"showTimeField": true
}
],
"ClosingStatusIds": [
3
],
"IsActionPlan": false,
"NewStatusId": 1
},
"messagingEnabled": true,
"statusMessage": "Successful",
"viewAddWatchersEnabled": true,
"viewValues": {
"ActivityNotes": [
{
"ActivityNote": "Tudtdyr",
"ActivityNoteDate": "/Date(1531893686557-0600)/",
"ActivityNoteDateFormatted": "2018-07-18T00:01:26.557-06:00",
"CaseActivityNoteId": 510,
"CaseId": 8141,
"FirstName": "John",
"FullName": "John Smith",
"HashCode": "4E4DAE1561E13312F534FCE496178C67DFCF05F8",
"LastName": "Smith",
"NoteFile": null,
"UserId": "861728bb-b83e-4946-ac14-0055b610c2f9"
}
],
"AlertName": "Alert 1 - DEV",
"CaseId": 8141,
"CasePriorityId": 2,
"CasePriorityTypeId": 2,
"CaseRootCauseAnswers": [],
"CaseRootCauseTreeIds": [],
"CaseStatusId": 2,
"CaseStatusTypeId": 2,
"CaseTriggerId": 301,
"CaseWatchers": [],
"CurrentUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"DateClosed": "/Date(1511969092027-0700)/",
"DateClosedFormatted": "Nov 29, 2017 8:24 AM",
"DateSubmitted": "/Date(1511894478230-0700)/",
"DateSubmittedFormatted": "Nov 28, 2017 11:41 AM",
"DisableCaseReassignmentNotifications": false,
"DisableCaseWatcherNotifications": false,
"FirstName": "Mark",
"ItemAnswers": [
{
"BoolValue": false,
"CaseId": 8141,
"CaseItemAnswerId": 3110,
"CaseItemId": 3535,
"CaseQuestionTypeId": 26,
"DoubleValue": 0,
"IntValue": 0,
"IsEmpty": false,
"TextValue": "2019-01-01T00:00:00",
"TimeValue": "/Date(1546326000000-0700)/"
},
{
"BoolValue": false,
"CaseId": 8141,
"CaseItemAnswerId": 0,
"CaseItemId": 3013,
"CaseQuestionTypeId": 13,
"DoubleValue": 0,
"IntValue": -1,
"IsEmpty": true,
"TextValue": "",
"TimeValue": "/Date(-2208963600000-0700)/"
},
{
"BoolValue": false,
"CaseId": 8141,
"CaseItemAnswerId": 0,
"CaseItemId": 3014,
"CaseQuestionTypeId": 12,
"DoubleValue": 0,
"IntValue": 0,
"IsEmpty": true,
"TextValue": "",
"TimeValue": "/Date(-2208963600000-0700)/"
},
{
"BoolValue": false,
"CaseId": 8141,
"CaseItemAnswerId": 0,
"CaseItemId": 3447,
"CaseQuestionTypeId": 13,
"DoubleValue": 0,
"IntValue": -1,
"IsEmpty": true,
"TextValue": "",
"TimeValue": "/Date(-2208963600000-0700)/"
}
],
"LastName": "Smith",
"ModifiedDate": "/Date(1568035817313-0600)/",
"ModifiedDateFormatted": "Sep 9, 2019 7:30 AM",
"OwnerEmail": "john.smith@maritzcx.com",
"OwnerFullName": "John smith",
"OwnerUserId": "861728bb-b83e-4946-ac14-0055b610c2f9",
"ProgramName": "mlk Program 1'ab",
"RespondentHash": null,
"RespondentId": 18880,
"SourceName": "",
"SourceResponses": [
{
"Key": -280,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "How did you originally become aware of the Dräger training?",
"ScaleId": 280
}
},
{
"Key": -1034,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 5856,
"AnswerIds": [
5856
],
"AnswerText": "Definitely Not",
"DisplayType": 0,
"QuestionText": "NPS Question ",
"ScaleId": 1034
}
},
{
"Key": -1053,
"Value": {
"AnswerDataType": "text",
"AnswerId": 5918,
"AnswerIds": [
5918
],
"AnswerText": "Biff",
"DisplayType": 0,
"QuestionText": "First Name",
"ScaleId": 1053
}
},
{
"Key": -1131,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 6383,
"AnswerIds": [
6383
],
"AnswerText": "02099_02099_BR",
"DisplayType": 0,
"QuestionText": "Franchise ID:",
"ScaleId": 1131
}
},
{
"Key": -1591,
"Value": {
"AnswerDataType": "ordinal",
"AnswerId": 1,
"AnswerIds": [
1
],
"AnswerText": "(Not Answered)",
"DisplayType": 0,
"QuestionText": "new Tac",
"ScaleId": 1591
}
}
],
"SourceValues": [
{
"Key": "item_-280",
"Value": "How did you originally become aware of the Dräger training?"
},
{
"Key": "item_-1034",
"Value": "NPS Question "
},
{
"Key": "item_-1053",
"Value": "First Name"
},
{
"Key": "item_-1131",
"Value": "Franchise ID:"
},
{
"Key": "item_-1591",
"Value": "new Tac"
}
],
"SurveyId": 79,
"SurveyName": "mlk Survey 1",
"SurveyResponseDate": "/Date(1511894394000-0700)/",
"SurveyResponseDateFormatted": "Nov 28, 2017 11:39 AM",
"TimeToClose": 74614,
"TimeToCloseColor": 1,
"TimeToCloseDays": 0,
"TimeToCloseDisplay": "0d 20h",
"TimeToCloseGoal": 14400,
"TimeToCloseGoalDays": 0,
"TimeToCloseGoalDisplay": "0d 4h",
"TimeToCloseGoalHours": 4,
"TimeToCloseHours": 20,
"TimeToRespond": 74541,
"TimeToRespondColor": 1,
"TimeToRespondDays": 0,
"TimeToRespondDisplay": "0d 20h",
"TimeToRespondGoal": 7200,
"TimeToRespondGoalDays": 0,
"TimeToRespondGoalDisplay": "0d 2h",
"TimeToRespondGoalHours": 2,
"TimeToRespondHours": 20,
"WatcherType": 0
}
}
}
Error Response
HTTP Status Code: 400
{
"UpdateCaseViewResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"UpdateCaseViewResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"UpdateCaseViewResult":{
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
POST updateCaseWatchers
Adds or removes case watchers.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
caseId=[int] Required
The ID of the case for which watchers are being updated, retrieved by the endpoint getMobileCaseInboxItems.
accessTypeId=[int] Required
The type of watcher that is being added or removed: 1 = Full Access, 2 = Limited Access.
watchersToAdd=[list] Required
A comma-delimited list of GUIDs of the users for whom you want to add access. You can also pass a blank value to not add any users. Note: If there is a problem with any user then the entire list is invalidated.
watchersToRemove=[list] Required
A comma-delimited list of GUIDs of the users for whom you want to remove access. You can also pass a blank value to not remove any users. Note: If there is a problem with any user then the entire list is invalidated.
messageToNewWatchers=[string] Optional
This is a message to send new watchers. Leave it blank if there is no message.
Sample Request
{
"token":"11111111-1111-1111-1111-111111111111",
"caseId":1,
"accessTypeId":1,
"watchersToAdd":"22222222-2222-2222-2222-222222222222,
44444444-4444-4444-4444-444444444444,
55555555-5555-5555-5555-555555555555",
"watchersToRemove":"66666666-6666-6666-6666-666666666666",
"messageToNewWatchers":"You have been added as a watcher!"
}
Response Values
UpdateCaseWatchersResult=[array]
Top-level response object returned by this endpoint, composed of the following element:
statusMessage=[string]
Value that indicates the result of the request to add or remove case watchers. Possible Values are 1) “Successful” – The request worked, accompanied by an HTTP status code of 200; or 2) Error Message.
Sample Response
{
"UpdateCaseWatchersResult":{
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"updateCaseWatchersResult":{
"statusMessage":"GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"updateCaseWatchersResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"UpdateCaseWatchersResult":{
"statusMessage":"Not logged in or unauthorized"
}
}
The token is invalid or the login is otherwise unauthorized.
HTTP Status Code: 400
{
"UpdateCaseWatchersResult":{
"statusMessage":"Case id doesn't exist in the system"
}
}
The case ID is not in the system.
HTTP Status Code: 400
{
"UpdateCaseWatchersResult":{
"statusMessage":"At least 1 user to add needs to be reviewed: 11111111-1111-1111-1111-111111111111 doesn't exist in the system; 22222222-2222-2222-2222-222222222222 is inactive in the system; "
}
}
At least 1 user in the add list is not valid. A list of defective users is returned in the message.
HTTP Status Code: 400
{
"UpdateCaseWatchersResult":{
"statusMessage":"At least 1 user to remove needs to be reviewed: 33333333-3333-3333-3333-333333333333 is locked out of the system; "
}
}
At least 1 user in the remove list is not valid. A list of defective users is returned in the message.
HTTP Status Code: 500
{
"UpdateCaseWatchersResult":{
"statusMessage":"Internal error: + [additional error message from server]"
}
}
Sample Call
TBD
Notes
POST updateSessionTimeout
Strobes the last access time so that the session time out is delayed.
URL
Parameters
token=[GUID] Required
Authentication token, which is retrieved by calling authenticate.
Sample Request
{
"token":"896541c3-70c8-4e5d-ace5-60bd6a758440"
}
Response Values
UpdateSessionTimeoutResult=[array]
Top-level response object returned by this endpoint, composed of the following elements:
statusMessage=[string]
Value that indicates the result of the updateSessionTimeout request. Possible values are 1) “Successful” – Session time out was delayed, accompanied by an HTTP status code of 200; and 2) Error Message.
sessionTimeout=[date]
Returns the time that the session expires.
Sample Response
{
"UpdateSessionTimeoutResult":{
"sessionTimeout":"\/Date(1428659877263-0400)\/",
"statusMessage":"Successful"
}
}
Error Response
HTTP Status Code: 400
{
"UpdateSessionTimeoutResult":{
"statusMessage":" GUID format error: Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
"token":null
}
}
A malformed GUID was passed in.
HTTP Status Code: 400
{
"UpdateSessionTimeoutResult":{
"statusMessage":"An error occurred logging out. Error Message: Missing or empty token.",
"token":null
}
}
The token GUID is empty or missing.
HTTP Status Code: 403
{
"UpdateSessionTimeoutResult":{
"sessionTimeout":null,
"statusMessage":"Error: Not logged in or unauthorized."
}
}
The token is invalid or the login is otherwise unauthorized.
Sample Call
TBD
Notes
Response Object – caseBulkExport
caseBulkExport is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| CaseActivityNotes | array | Composed of the following child elements:
|
| CaseAlertName | string | The name of the case alert. |
| CaseClosedDate | string | The date on which the case was closed, in Unix format. |
| CaseFormFieldValues | array | Complex second-level response object returned by this endpoint. Contains the following children:
|
| CaseID | int | The ID of the case. |
| CaseModifiedDate | string | The date on which the case was closed, in Unix format. |
| CaseOwnerEmail | string | Email address of the case owner. |
| CaseOwnerName | string | The name of the case owner. |
| CasePriority | string | The priority of the case; possible values are High, Medium, or Low. |
| CaseProgramName | string | The name of the case program. |
| CaseRootCauseValues | array | Complex second-level response object returned by this endpoint. Contains the following children:
|
| CaseStatus | string | The priority of the case; possible values are New, In Progress, or Closed. |
| CaseSubmittedDate | date | The date on which the case was created, in Unix format. |
| CaseTimeOffset | int | Time in seconds that will be taken off of the case time to respond and case time to close. |
| CaseTimeToClose | int | If the case has been closed, time in seconds that it took to close; if the case has not been closed yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseTimeToCloseDays | int | If the case has been closed, number of whole days it took to close; if the case has not been closed yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseTimeToCloseHours | int | If the case has been closed, number of hours (in addition to whole days) it took to close; if the case has not been closed yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseTimeToRespond | int | If the case has been responded to, time in seconds that it took the caseworker to respond; if the case has not been responded to yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseTimeToRespondDays | int | If the case has been responded to, number of whole days it took the caseworker to respond; if the case has not been responded to yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseTimeToRespondHours | int | If the case has been responded to, number of hours (in addition to whole days) it took the caseworker to respond; if the case has not been responded to yet, then this value will be calculated from the DateSubmitted to the current time the export is being run. |
| CaseWatcherValues | array | Complex second-level response object returned by this endpoint. Contains the following children:
|
| DataReferences | array | Second-level response object returned by this endpoint. Contains the following children:
Note: DataReferences will include any Data References that have been created and currently exist on the Case Form. |
| Escalated | boolean | Whether or not the case has been escalated; possible values are “true” and “false”. |
| PriorityValues | array | Complex second-level response object returned by this endpoint. Contains the following children:
|
| RespondentID | int | The ID of the respondent. |
| StatusValues | array | Complex second-level response object returned by this endpoint. Contains the following children:
|
| SurveyName | string | The name of the survey that triggered the case. |
| TimeToCloseGoal | int | Goal that has been defined for closing the case, expressed in seconds. |
| TimeToCloseGoalDays | int | Goal that has been defined for closing the case, in whole days. |
| TimeToCloseGoalHours | int | Goal that has been defined for closing the case, in hours (in addition to whole days). |
| TimeToRespondGoal | int | Goal that has been defined for responding to the case, expressed in seconds. |
| TimeToRespondGoalDays | int | Goal that has been defined for responding to the case, in whole days. |
| TimeToRespondGoalHours | int | Goal that has been defined for responding to the case, in hours (in addition to whole days). |
Response Object – caseMessageInfo
caseMessageInfo is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| CaseID | int | Case Identifier that is associated with the message. |
| CurrentUserName | string | User name of the logged in user. |
| EmailAddress | string | User name of the logged in user |
| EnableCaseMessaging | bool | True = Case messaging is enabled; False = not enabled/td> |
| FirstName | string | Logged-in user’s first name |
| LastName | string | Logged-in user’s last name |
| MessageSubject | string | Subject of the message |
| Messages | array | Messages object |
| MessagingEmployeeIdentificationLabel | string | Text used to address the message owner |
| MessagingLabel | string | Text used to identify the recipient of the message |
| PredefineTemplateCount | int | Number of predefined templates |
| TotalMessageCount | int | Number of messages received |
| UseAnonymousName | bool | If true the recipient name is not identified. |
Response Object – casePredefinedResponse
casePredefinedResponse is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| CasePredefinedResponseId | int | Case predefined response identifier. |
| CaseProgramId | int | Identifier of the case program that this alert belongs to. |
| CreatedBy | GUID | Identifier of the user that created the predefined template. |
| CreatedDate | date | Date the predefined response was created. |
| DefaultAlerts | array | Array of alerts that this predefined response pertains to. For API usage, if the count is greater than 0 then it’s the default response. |
| Name | string | Name of the scripted response. |
| RecordStatusTypeId | int | Status of the predefined response; 1 = Active, 2 = Inactive, and 3 = To Be Deleted |
| Response | string | Message text for the scripted response. |
Response Object – Case Question Types
The following table gives the values possible for CaseQuestionType:
| CaseQuestionType | Number |
|---|---|
| CaseId | 1 |
| ProgramName | 2 |
| SubmittedDate | 3 |
| Status | 4 |
| Priority | 5 |
| RootCause | 6 |
| Comment | 7 |
| 8 | |
| CaseOwner | 9 |
| AlertType | 10 |
| ShortText | 11 |
| LongText | 12 |
| Dropdown | 13 |
| Checkbox | 14 |
| Source | 15 |
| ClosedDate | 16 |
| SurveyName | 17 |
| TimeToRespond | 18 |
| TimeToClose | 19 |
| Paragraph | 20 |
| Divider | 21 |
| CcWatcher | 22 |
| Escalated | 23 |
| LastModifiedDate | 25 |
| DatePicker | 26 |
| Numeric | 27 |
| UsedInternally | 28 |
| HyperLinkControl | 29 |
| RespondentIDFromSurvey | 30 |
| SurveyResponseDate | 31 |
| HasFollowupSurvey | 32 |
Response Object – caseView
caseView is composed of the following child elements:
CaseStatusIds
These are an array of status identifiers that can be set on the case.
CaseCanvasSettings
| Element | Type | Description |
|---|---|---|
| height | int | Height of the canvas in pixels. |
| width | int | Width of the canvas in pixels. |
| showGrid | boolean | Indicates whether or not the page grid will display. |
| showPageBreaks | boolean | Indicates whether or not page breaks will display. |
| paperSize | paperSize | Sets the expected paper size. Possible values include letter, legal, and a4. |
| elements [Note – the elements portion has been removed in all newer case forms (created or modified after the January 2018 release] | Array of child objects | Composed of the following child elements:
|
CaseViewItems
CaseViewItems is an array that contains the following child elements:
| Element | Type | Description |
|---|---|---|
| CaseId | int | Case identifier. |
| CaseItemId | int | Case item identifier. |
| CaseItemText | string | Control text. |
| CaseProgramId | int | Case program identifier. |
| CaseQuestionTypeId | int | Case question type, see Case Question Type for the enumeration of its values. |
| DefaultDropdownValues | array | Dropdown only – An array of CaseItemList IDs that are to be displayed by default. |
| DefaultHyperlinkText | string | Hyperlink only – A string value of the text that the hyperlink control defaults to |
| DefaultHyperlinkUrl | string | Hyperlink only – A string value of the URL that the hyperlink control defaults to. |
| DefaultRootCauseValues | array | Root Cause only – Array of tree_IDs that are to be visible when the case view is displayed. |
| DefaultValue | string or null | Default value on the control; only valid for short or long text answers. |
| DefaultVisibilityTypeId | int | 0 – control defaults to not visible, 1 – defaults to visible. |
| DisplayRules | array | Array of properties and objects that store rules for setting caseitem visibility. Used internally. This object is currently in testing and subject to change. |
| DropdownValues | array | Composed of the following child elements:
|
| FormatString | string | JSON string for format identifiers for a control. It is composed of the following child elements:
|
| HyperLinkResourceKey | string | ResourceKey value for the URL text. Used internally. |
| HyperlinkText | string | Applies to the hyperlink control – the name of the control for conditional display purposes. |
| HyperlinkUrl | string | Applies to the hyperlink control. This string represents the URL value of the control. |
| HyperLinkUrlResourceKey | string | ResourceKey value for the URL text. Used internally. |
| IsEmailAddress | boolean | True if the corresponding field contains an email address; otherwise false. |
| IsGroupParent | boolean | The API allows one level of nesting and a case item can be a group header. If it is a group header, then this property will be set to true, otherwise it is false. |
| IsPhoneNumber | boolean | True if the corresponding field contains a phone number; otherwise false. |
| mobileIndex | int | Index of the property on the case as assigned by the case management administrator. |
| mobileText | string | Applies to paragraph controls only – only text without any style controls in the html. |
| NeededToClose | boolean | Question that must be answered in order to set case status to “Closed”. |
| ParentItemID | int | 0 if the item has no parent, > 0 if the item has a parent. |
| ResourceKey | string | CaseItem resource key name |
| RootCauseValues | array | Root cause tree array. Composed of the following child elements:
|
| showTimeField | boolean | Applies to Time to Respond and Time to Close controls and determines whether the Time field will display. |
| SourceScaleId | int | Survey question scale identifier – used for meta-questions based on survey questions, i.e. data definitions. |
| VisibilityTypeId | int | 0 – control defaults to not visible, 1 – defaults to visible. |
ClosingStatusIds
These are an array of status identifiers that can close a case.
Response Object – companies
companies is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| Address | object | Composed of the following child elements:
|
| CompanyDBGroupId | int | Internal use identifier. |
| CompanyId | int | Company identification number. |
| CompanyName | string | Company’s profile name.* |
| CompanySettings | string | JSON string of company settings. Currently null, to be filled in the future. |
| LicenseFeatures | array | License Id object, to be filled in the future. |
| ParentCompanyId | int | Parent company identifier used for company hierarchy. |
| PasswordPolicy | string | Password policy for users set by the company. |
| PhoneNumber | string | Phone number. |
| Selected | boolean | Selected company used for last selected company for login purposes. |
| UserCompanySettings | string | JSON string of user settings set at the company level, currently null, to be filled in the future. |
* This element used to be called companyName.
Response Object – historyChangeType
historyChangeType is composed of the following child elements:
| CaseQuestionType | Number |
|---|---|
| StatusChange | 100 |
| PriorityChange | 200 |
| ActivityNoteAdd | 300 |
| ActivityNoteUpdate | 301 |
| ActivityNoteDelete | 302 |
| ShortTextAdd | 400 |
| ShortTextUpdate | 401 |
| LongTextAdd | 500 |
| LongTextUpdate | 501 |
| RootCauseChange | 600 |
| OwnerChange | 700 |
| DropdownChange | 800 |
| ReminderSent | 900 |
| EscalationSent | 901 |
| MobilePhoneCallAttempted | 2000 |
| MobileEmailAttempted | 2001 |
Response Object – messages
messages is an array composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| CaseID | int | Case Identifier |
| CaseMessageID | int | Case Message identifier |
| UserId | string | User identifier GUID, may be null for external messages |
| UserName | string | Full name of user, may be null for external messages |
| CaseMessageTypeID | int | Case Message Type: 1 = Internal message (from caseworker), 2 = External message (from customer) |
| MessageUnread | bool | True if message has not been read by logged in user, false if it has been read |
| MessageText | string | Text of the message |
| MessageDate | date | Date the message was sent |
| MessageDateFormatted | string | Formatted message date in string; date is in the logged-in user’s date/time format. For information on your server’s time zone, see Time Zones under the Overview. |
| ModifiedDate | date | Last modified date |
| MessageFile | array | Actual file is not sent in response, just metadata about the file. Can be ignored in mobile development. Contains the following fields:
|
Response Object – Rows
Rows is composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| CaseId | int | Case Identifier. |
| Columns | array | See the additional table below. |
| IsActionPlan | boolean | True if the case is part of an action plan instead of a case management program, false if it is part of a case management program. |
| NewMessageCount | int | Number of messages that haven’t been read. |
| RespondentId | int | Respondent Identifier that caused the case to be generated. |
| SortIndex | int | Order of column inside the row. By default they are in order but you can arrange them manually if necessary. |
| StatusName | string | Localized text value for the status of the case; values in English: New, In Progress, or Closed. |
Columns
Columns is a parent element within Rows composed of the following children:
| Element | Type | Description |
|---|---|---|
| CaseQuestionTypeId | int | Case question type ID, see this. |
| ColumnColorValue | int | Color of the time to respond. One of the following values:
|
| ColumnName | string | Column Name of case item or survey question. |
| ColumnValue | string | Answer. |
| SortIndex | int | Order of elements within the column. By default they are in order but you can arrange them manually if necessary. |
Response Object – userAccount
userAccount is composed of the following child elements:
| Element | Type | Description |
|---|---|---|
| FullName | string | The user’s full name – usually consists of the first name and last name concatenated. |
| FirstName | string | The user’s first name. |
| LastName | string | The user’s last name. |
| UserId | GUID | The GUID that represents the user’s identifier. |
| UserName | string | The user’s username. |
Response Object – viewValues
viewValues is composed of the following child elements:
ActivityNotes
ActivityNotes is an array within viewValues that contains the following child elements:
| Element | Type | Description |
|---|---|---|
| ActivityNote | string | Note text. |
| ActivityNoteDate | date | Date note was saved. |
| ActivityNoteDateFormatted | string | Formatted date follows user settings. |
| CaseActivityNoteId | int | Case activity note identifier. |
| CaseId | int | Case identifier this note is attached to. |
| CaseTriggerId | int | The case alert trigger identifier that was satisfied to create this case. |
| FirstName | string | First name of user who entered the note. |
| FullName | string | Full name of user who entered the note. |
| HashCode | hashed string | Internal use. |
| LastName | string | Last name of user who entered the note. |
| NoteFile | notefileobject | Attached note file object, not presented in mobile. |
| UserId | string | User ID form of a GUID. |
| Element | Type | Description |
|---|---|---|
| AlertName | string | Name of Alert – answer for Alert Case item. |
| CaseId | int | Case Identifier – answer for Case ID case item. |
| CasePriorityTypeId | int | Id of case priority that has been selected – 0 = No value selected, 1 = High, 2 = Medium, and 3 = Low. |
| CaseRootCauseAnswers | object | Array of CaseRootCauseAnswer objects that have been selected:
Example: “CaseRootCauseAnswers”: [ |
| CaseRootCauseTreeIds | string | Array of root cause tree identifiers that have been selected.
Example: “CaseRootCauseTreeIds”: [ |
| CaseStatusTypeId | int | ID of case status that has been selected – 1 = New, 2 = In Progress and 3 = Closed. |
| CurrentUserId | string | Current user ID GUID. |
| CaseWatchers | object | Array of CaseWatcher objects that represent the user that have watcher access:
Example: “CaseWatchers” : [{ |
| DateClosed | date | Date case was closed. |
| DateClosedFormatted | string | Formatted closed date follows user settings – null string if not closed. |
| DateSubmitted | date | Date case was created. |
| DateSubmittedFormatted | string | Formatted created date follows user settings. |
| DisableCaseWatcherNotifications | bool | Case Watcher notification state.
Example: “DisableCaseWatcherNotifications”: false, |
| DisableCaseReassignmentNotifications | bool | True if reassignment notifications are turned off, false if they are on. |
| FirstName | string | Case owner first name. |
| ModifiedDate | date | Last modified date
Example: “ModifiedDate”: “/Date(1459440564760+0200)/”, |
| ModifiedDateFormatted | string | Formatted modified date
Example: “ModifiedDateFormatted”: “Mar 31, 2016 06:09 PM”, |
| ownerFullName | string | Full name of the owner. |
ItemAnswers
ItemAnswers is an array of item answers used for short text and long text.
| Element | Type | Description |
|---|---|---|
| BoolValue | boolean | Boolean answer if control is boolean. |
| CaseId | int | Case ID this answer is attached to. |
| CaseItemAnswerId | int | Case answer ID, unique. |
| CaseItemId | int | Case item ID this answer is attached to. |
| CaseQuestionTypeId | int | Case question type ID, see this. |
| DoubleValue | double | Answer to a case form numeric control. |
| IntValue | int | Integer answer if int/dropdown. |
| IsEmpty | boolean | If no value then true, else false. |
| TextValue | string | String answer if text type. |
| TimeValue | date | Answer to the case form Date Picker control. |
| Element | Type | Description |
|---|---|---|
| LastName | string | Case owner last name – answer for case owner. |
| OwnerEmail | string | Owner email address. |
| OwnerUserId | string | Case owner ID GUID. |
| ProgramName | string | Case program name. |
| RespondentHash | string | For internal use. |
| RespondentId | int | Survey respondent ID. |
| SourceName | string | Case source name – future. |
| SourceResponses | array | Array of key value pairs. Key is the CaseItemID of the data reference. The value is the answer object:
{ Example: |
| SourceValues | array | Array of key/value pairs:
|
| SurveyId | int | Identifier for the associated survey.
Example: “SurveyId”: 17, |
| SurveyName | string | Survey name – answer for Survey Name. |
| SurveyResponseDate | date | Date the survey was completed. |
| SurveyResponseDateFormatted | string | Formatted survey response date; follows user settings. |
| TimeToClose | int | Time to close program setting – answer for time to close. |
| TimeToCloseColor | int | Color of the time to close. One of the following values:
|
| TimeToCloseDays | int | Integer for number of days to close. |
| TimeToCloseDisplay | string | Time to close, formatted to display as day/hour. |
| TimeToCloseGoal | int | Time to close goal, 0 if not set. |
| TimeToCloseGoalDays | int | Time to close goal; day part. |
| TimeToCloseGoalDisplay | string | Formatted string of time to close goal. |
| TimeToCloseGoalHours | int | Time to close goal; hour part. |
| TimeToCloseHours | int | Time to close; hour part. |
| TimeToRespond | int | Time to respond raw – in seconds. |
| TimeToRespondColor | int | Color of the time to respond. One of the following values:
|
| TimeToRespondDays | int | Time to respond; day part. |
| TimeToRespondDisplay | string | Formatted time to respond. |
| TimeToRespondGoal | int | Time to respond goal – 0 if not set. |
| TimeToRespondGoalDays | int | Time to respond goal; day part. |
| TimeToRespondGoalDisplay | string | Formatted time to respond goal. |
| TimeToRespondGoalHours | int | Time to respond goal; hour part. |
| TimeToRespondHours | int | Time to respond; hour part. |
| WatcherType | int | User is a watcher with either full [1] or limited [2] access; decides if the user can create an activity note. |
Data Import API
Overview
The Data Import API allows you to import survey response data into the MaritzCX platform through a simple HTTP endpoint, as well as retrieve the status of previously executed imports.
Permissions
To use the Data Import API, you must be one of the following:
- Survey Owner
- Survey Analyst
- Survey Manager
Note: It is strongly recommended that you create a user account solely for use with the Data Import API.
Getting Started
To connect to the Data Import API, use the following as your base URL:
North America – https://dataimportapi.allegiancetech.com/api
Europe, the Middle-East, and Africa – https://dataimportapi.mcxplatform.de/api
Australia – https://dataimportapi.mcxplatform.com.au/api
ProdNE – https://dataimportapi.us1.allegiancetech.com/api
Note: In order to use the Data Import API, you must be on new imports, not classic.
Rate Limit
To keep the API performant for all consumers, the MaritzCX platform implements rate limiting. That means that in a given time period you will only be allowed to send a certain number of requests. We’ve kept these limits high enough to allow standard usage of the API while still low enough to prevent abuse of the service.
The limits are as follows:
- 1 request per second
- 10,000 requests per day
If the rate limit is exceeded then you will receive an HTTP 429 response with following message in the body:
“Rate limit exceeded. Please try again later.”
Versioning
There is a header on all requests that indicates which version of the API is being called. In it, the key should be “api-version” and the value should be “3.0”.
Case-Insensitivity
Parameters for the Data Import API are not case-sensitive.
POST authenticate
When the user is successfully authenticated, a token is returned as a guid. This token should be passed through the “Authentication-Token” request header on all future API calls.
Every successful authentication request will return a new authentication token. By default, tokens are set to expire after 30 minutes.
URL
Parameters
username=[String] Required
This is the platform username.
password=[String] Required
This is the platform password.
Sample Request
{
"username": "first.last@emaildomain.com",
"password": "password"
}
Response Values
HTTP Code=200
This indicates success; accompanied by a token.
Sample Response
3412af7d-eda1-412f-b276-2ec0e9ed5c60
Error Response
HTTP Status Code: 401
This indicates failure.
Sample Call
curl -X POST "https://dataimportapi.allegiancetech.com/api/Authenticate" -H "accept: application/json" -H "api-version: 3.0" -H "Content-Type: application/json-patch+json" -d "{ \"username\": \"Blabbus\", \"password\": \"password\"}"
Notes
GET duplicateRespondents
If a UniqueKeyQuestion was provided in an import request, then it’s possible that some of the respondents will not be imported because they would have created duplicates in the platform. In that case, a user can call the duplicateRespondents endpoint to get a list of any respondents that were not imported due to duplicates already existing in the platform.
The response will contain a paged list of responses. Those responses have four properties:
- InstanceId – indicates which import request was used to create this duplicate.
- RecordOrdinal – indicates which record number the respondent was. RecordOrdinal is zero-based.
- RespondentId – indicates which respondent in the system would have been duplicated.
- UniqueKeyValue – value from the Import request that is also included.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[string] Required
Unique code for the survey to which the import belongs; transmitted in the path of the request.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
instanceId=[integer] Required
Id of the import instance; transmitted in the path of the request.
pageNumber=[integer] Optional
Page number of results to be returned; each page contains 50 items; transmitted in the query of the request.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123/duplicaterespondents?pageNumber=1
Response Values
HTTP Code=200
200 indicates a successful response.
PageNumber=[int]
Duplicate respondent results are presented in the form of pages; this indicates which page number the Results array is presently on.
PageSize=[int]
Number of duplicate respondents present on the page.
Results=[array]
Top-level response object returned by this endpoint. Composed of the following children:
InstanceId=[int]
The import request that was used to create this duplicate.
RecordOrdinal=[int]
The record number that the respondent was. RecordOrdinal is zero-based.
RespondentId=[int]
The respondent in the system that would have been duplicated.
UniqueKeyValue=[int]
The value from the import request that caused the duplication.
Sample Response
{
"pageNumber": 1,
"pageSize": 2,
"nextPageUrl": "https://example.com/survey/page_2",
"results": [
{
"InstanceId": 7725,
"RecordOrdinal": 0,
"RespondentId": 2432636,
"UniqueKeyValue": "7108"
},
{
"InstanceId": 7725,
"RecordOrdinal": 1,
"RespondentId": 2432637,
"UniqueKeyValue": "7109"
}
]
}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
HTTP Status Code: 404
Occurs if the requested resource cannot be found.
Sample Call
curl -X GET "https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/4545/duplicateRespondents?pageNumber=1" -H "accept: application/json" -H "api-version: 3.0"
Notes
POST editRequest
The editRequest method takes as input one object that fully describes an edit/append import. It is used to modify survey responses or sample data that already exists within the platform. Like the standard importRequest, it will contain a name, a survey code, notification email addresses, a flag as to whether alerts should be sent after the import is complete, and an array of survey responses.
It also contains four extra properties: editType, createRespondents, editKeyType, and editKeyQuestion. The individual respondent objects also require an additional property called editKey. These are described in greater depth below.
The responses section, which contains all of responses to the survey questions, works in exactly the same way as the importRequest end point.
If the request is formed properly it will immediately return an HTTP 202. The edit import will then be queued for execution. This method will return an InstanceId, which you can then plug into the importStatus method to check the progress of the import.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
request=[string] Required
A complete import object; presented in the request body as a JSON string. Composed of the remaining parameters below.
surveyCode=[string] Required
The six-character token that uniquely identifies a survey. This code can be retrieved from the “Survey ID” field on the “Manage Survey” page of the platform.
sendAlerts=[boolean] Optional
Determines whether Case Management cases will be created; possible values are “true” and “false”.
name=[string] Required
The name of the import.
notificationEmails=[string] Optional
A comma-separated list of e-mail addresses to which import status notifications should be sent.
editType=[string] Required
This property specifies the type of edit being performed. The only options are “Invitation” and “Response”.
createRespondents=[string] Optional
If “Invitation” is specified for “EditType”, the edit will create respondents associated with the matched invitations where they don’t yet exist. This is useful for scenarios in which sample originates in the MCX platform, but survey taking occurs elsewhere.
editKeyType=[string] Required
Specifies the type of key used to match respondents in the request with respondents/invitations in the platform. The options are:
- “sampleDetailId”
- “respondentId”
- “question”
- “authenticationKey”
The “sampleDetailId” and “authenticationKey” options are only valid if the editType is “invitation”. The “respondentId” option is only valid if editType is “response”. The “question” option can be used for either.
editKeyQuestion=[string] Optional
When the editKeyType is set to “question”, this is used to specify which question will be used as an edit key.
respondents=[array] Required
An array of objects where each object represents a survey taker. Each respondent requires response(s). Each respondent also requires an editKey property.
editKey=[string] Required
The editKey property is used to indicate how to match the respondent in this request to a respondent or sample record in the platform. When using sampleDetailId, respondentId, or authenticationKey as the editKeyType, the value here should just match up to that value. When using question as the editKeyType, the answer to the question should be provided as the value of the editKey.
responses=[properties] Required
One or more JSON properties that contain(s) the survey question tag and the value representing the answer to the question. The value of the property should correspond in type to the question. For questions that can have multiple answers the value should be an array of answers. If the question has an “other” option then it should be its own property where the name is the question tag with “-other” after it. For example, if the question tag is “favoriteColor”, the “other” option should be represented by a property named “favoriteColor-Other”.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
{
"surveyCode": "8SFFC3",
"sendAlerts": false,
"name": "Example Edit Response",
"notificationEmails": "john@smith.com,jane@doe.com",
"editType": "Response",
"createRespondents": "false",
"editKeyType": "Question",
"editKeyQuestion": "FavColor",
"respondents": [
{
"editKey": "Red",
"responses": {
"OSAT": 5
}
},
{
"editKey": "Green",
"responses": {
"OSAT": 1
}
}
]
}
Response Values
HTTP Code=202
InstanceId=[int]
Identifier of the successful editRequest instance, which you can then plug into the importStatus method to check the progress of the import.
Sample Response
{ "InstanceId": 1234}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
Sample Call
curl -X POST "https://dataimportapi.dev.mcxplatform.com/api/editrequest" -H "accept: application/json" -H "api-version: 3.0" -H "Content-Type: application/json-patch+json" -d "{ \"editType\": \"Invitation\", \"createRespondents\": true, \"editKeyType\": \"Question\", \"editKeyQuestion\": \"question-tag-edit-key\", \"surveyCode\": \"8SFFC3\", \"sendAlerts\": false, \"name\": \"Example Response Import\", \"notificationEmails\": \"john@smith.com,jane@doe.com\", \"respondents\": [ { \"CompletedDate\": \"2017-09-16T07:20:45Z\", \"StartedDate\": \"2017-09-15T08:28:40Z\", \"Language\": \"English\", \"Responses\": { \"question-tag-numeric\": 7, \"question-tag-text\": \"Example Single Answer\", \"question-tag-multiple-text\": [ \"Answer 1\", \"Answer 2\", \"Answer 3\" ], \"question-tag-multiple-numeric\": [ 5, 6, 7 ] } }, { \"CompletedDate\": \"2017-09-17T07:20:45Z\", \"StartedDate\": \"2017-09-16T08:28:40Z\", \"Language\": \"English\", \"Responses\": { \"question-tag-numeric\": 3, \"question-tag-text\": \"Example of another single answer\", \"question-tag-multiple\": [ \"Answer 4\", \"Answer 5\", \"Answer 6\" ], \"question-tag-multiple-numeric\": [ 4, 3, 2 ] } } ]}"
Notes
POST importRequest
The importRequest method takes an object that fully describes one import as input. This object will contain a name, a survey code, notification email addresses, a flag as to whether alerts should be sent after the import is complete, and an array of survey responses. There is one example of that object posted in the sample request section here. The question tags give an indication as to how to format different question types.
If the request is formed properly it will immediately return an HTTP 202. The import will then be queued for execution. This method will return an InstanceId, which you can then plug into the importStatus method to check the progress of the import.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
request=[string] Required
A complete import object; presented in the request body as a JSON string. See the example below.
surveyCode=[string] Required
The six-character token that uniquely identifies a survey. This code can be retrieved from the “Survey ID” field on the “Manage Survey” page of the platform.
sendAlerts=[boolean] Optional
Determines whether Case Management cases will be created; possible values are “true” and “false”.
name=[string] Required
The name of the import.
notificationEmails=[string] Optional
A comma-separated list of e-mail addresses to which import status notifications should be sent.
uniqueRequestKey=[string] Optional
A user-defined value to use as a key for the request. If another request is made using the same key it will be ignored.
respondents=[array] Required
A JSON array of objects where each object represents a survey taker. Each discrete respondent is composed of the following elements:
CompletedDate=[string] Required
Date on which the data import was completed, in UTC form.
StartedDate=[string] Required
Date on which the data import was started, in UTC form.
Language=[string] Required
Language of the data import; possible values for it are determined by the languages configured for the survey.
responses=[properties] Required
One or more JSON properties that contain(s) the survey question tag and the value representing the answer to the question. The value of the property should correspond in type to the question. For questions that can have multiple answers the value should be an array of answers. If the question has an “other” option then it should be its own property where the name is the question tag with “-other” after it. For example, if the question tag is “favoriteColor”, the “other” option should be represented by a property named “favoriteColor-Other”.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
{
"surveyCode": "8SFFC3",
"sendAlerts": false,
"name": "Example Response Import",
"notificationEmails": "john@smith.com,jane@doe.com",
"UniqueRequestKey": "HourlyImport-20180209T130000",
"Respondents": [
{
"CompletedDate": "2017-09-16T07:20:45Z",
"StartedDate": "2017-09-15T08:28:40Z",
"Language": "English",
"Responses": {
"question-tag-numeric": 7,
"question-tag-text": "Example Single Answer",
"question-tag-multiple-text-with-other": [
"Answer 1",
"Answer 2",
"Answer 3",
"Other Answer"
],
"question-tag-multiple-numeric": [
5,
6,
7
],
"question-tag-rank": [
"Answer 3",
"Answer 1",
"Answer 2"
]
}
},
{
"CompletedDate": "2017-09-17T07:20:45Z",
"StartedDate": "2017-09-16T08:28:40Z",
"Language": "English",
"Responses": {
"question-tag-numeric": 3,
"question-tag-text": "Example of another single answer",
"question-tag-multiple-text-with-other ": [
"Answer 4",
"Answer 5",
"Other Answer",
"Answer 6"
],
"question-tag-multiple-numeric": [
4,
3,
2
]
}
}
]
}
Response Values
HTTP Code=202
InstanceId=[int]
Identifier of the successful importRequest instance, which you can then plug into the importStatus method to check the progress of the import.
Sample Response
{ "InstanceId": 1234}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
Sample Call
curl -X POST "https://dataimportapi.dev.mcxplatform.com/api/importrequest" -H "accept: application/json" -H "api-version: 3.0" -H "Content-Type: application/json-patch+json" -d "{ \"surveyCode\": \"8SFFC3\", \"sendAlerts\": false, \"name\": \"Example Response Import\", \"notificationEmails\": \"john@smith.com,jane@doe.com\", \"respondents\": [ { \"CompletedDate\": \"2017-09-16T07:20:45Z\", \"StartedDate\": \"2017-09-15T08:28:40Z\", \"Language\": \"English\", \"Responses\": { \"question-tag-numeric\": 7, \"question-tag-text\": \"Example Single Answer\", \"question-tag-multiple-text\": [ \"Answer 1\", \"Answer 2\", \"Answer 3\" ], \"question-tag-multiple-numeric\": [ 5, 6, 7 ] } }, { \"CompletedDate\": \"2017-09-17T07:20:45Z\", \"StartedDate\": \"2017-09-16T08:28:40Z\", \"Language\": \"English\", \"Responses\": { \"question-tag-numeric\": 3, \"question-tag-text\": \"Example of another single answer\", \"question-tag-multiple\": [ \"Answer 4\", \"Answer 5\", \"Answer 6\" ], \"question-tag-multiple-numeric\": [ 4, 3, 2 ] } } ]}"
Notes
DELETE imports
The DELETE imports endpoint performs an undo on a previously executed import, or rolls back the changes from a previously executed edit request.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[string] Required
Unique code for the survey to which the import belongs; transmitted in the path of the request.
instanceId=[integer] Required
Id of the import instance; transmitted in the path of the request.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/412/imports/2334
Response Values
HTTP Code=200
200 indicates a successful response.
Sample Response
200
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
Sample Call
curl -X DELETE "https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/2334" -H "accept: application/json" -H "api-version: 3.0"
Notes
GET imports
The imports endpoint returns a list of data imports for a given survey. It returns pages of 50 records at a time.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[string] Required
Unique code for the survey to which the import belongs; transmitted in the path of the request.
pageNumber=[integer] Optional
Page number of the results to be returned. Each page contains 50 items; transmitted in the query of the request.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports?pageNumber=1
Response Values
HTTP Code=200
200 indicates a successful response.
PageNumber=[int]
Data import results are presented in the form of pages; this indicates which page number the Results array is presently on.
PageSize=[int]
The number of data imports present on the page.
NextPageUrl=[string]
The URL to get the next page of results from.
Results=[array]
Array of import results, composed of the following elements:
InstanceId=[int]
The import request that was used to create this data import.
Name=[string]
The name of the data import.
ImportType=[string]
The type of the data import; possible values are “ResponseImport”, “EmailListImport”, “ResponseImportEditAppend”, and “InvitationImportEditAppend”.
ImportedDate=[string]
The date on which the data import was executed, expressed in UTC.
Status=[string]
Status of the data import; possible values are “Configuring”, “ValidationRequested”, “Validating”, “Validated”, “ExecutionRequested”, “Executing”, “ExecutionPaused”, “Executed”, “UndoRequested”, “Undoing”, “UndoPaused”, “Undone”, “Error”, “EmptyFile”, “DeletionRequested”, and “Deleting”.
FileName=[string]
Name of the data import file.
TotalRecords=[int]
Total number of records in the data import.
SuccessRecords=[int]
Number of successful records within the data import.
TotalImportedRespondents=[int]
Total number of respondents contained within the data import.
NotificationEmails=[string]
Email address(es) that was/were marked to receive notification of the data import.
SendAlerts=[bool]
Whether basic alerts could be sent or Case Management cases could be created from the data import; possible values are “true” and “false”.
ValidationLogLink=[string]
URL that points to the validation log.
Sample Response
{
"PageNumber": 1,
"PageSize": 2,
"NextPageUrl": "https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports?pageNumber=2",
"Results": [
{
"InstanceId": "123",
"Name": "My Import",
"ImportType": "ResponseImport",
"ImportedDate": "2017-08-01T14:30:34.57",
"Status": "Executed",
"FileName": "jsonpayload.json",
"TotalRecords": 2,
"SuccessRecords": 2,
"TotalImportedRespondents": 2,
"NotificationEmails": "name@example.com",
"SendAlerts": false
"validationLogLink": "https:example.com/123"
},
{
"InstanceId": "124",
"Name": "My Second Import",
"ImportType": " ResponseImport",
"ImportedDate": "2017-08-01T14:28:04.08",
"Status": "Executed",
"FileName": "jsonpayload.json",
"TotalRecords": 21,
"SuccessRecords": 25,
"TotalImportedRespondents": 25,
"NotificationEmails": "name@example.com",
"SendAlerts": false
"validationLogLink": "https:example.com/124"
}
]
}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
Sample Call
TBD
Notes
GET importStatus
After creating an import, you can use the InstanceId to retrieve status information about it. This method will return information including the import name, its status (Configuring, ValidationRequested, Validating, Validated, ExecutionRequested, Executing, Executed, UndoRequested, Undoing, Undone, or Error.) The information returned will differ dependent on the type of import. Edits will include information on if multiple respondents were modified, if respondents were unmodified, EditKeyType, EditKeyQuestion, and a link to get a list of the keys that were unmodified if there were unmodified keys.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[Integer] Required
Id of the survey to which the import belongs, issued as a query; can be discovered using the Survey Management API.
instanceId=[Integer] Required
Id of the import instance, issued as a query.
api-version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123
Response Values
HTTP Code=200
Id=[int]
ID of the data import.
Name=[string]
Name of the data import.
Status=[string]
Status of the data import; possible values are “Configuring”, “ValidationRequested”, “Validating”, “Validated”, “ExecutionRequested”, “Executing”, “ExecutionPaused”, “Executed”, “UndoRequested”, “Undoing”, “UndoPaused”, “Undone”, “Error”, “EmptyFile”, “DeletionRequested”, and “Deleting”.
ImportedDate=[string]
Date on which the data import was executed, presented in UTC.
TotalRecordsImported=[int]
Total number of records in the data import.
ValidationLogLink=[string]
URL that points to the validation log.
Sample Response
{
"Id": 123,
"Name": "My Import",
"Status": "Completed",
"ImportedDate": "2017-07-03T02:14:24.327",
"TotalRecordsImported": 10,
"ValidationLogLink":
"https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123/validationlog"
}
Note: ValidationLogLink is the URL that points to the validation log.
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
Sample Call
curl -X GET "https://dataimportapi.allegiancetech.com/api/survey/123/imports/4545" -H "accept: application/json" -H "api-version: 3.0"
Notes
GET unmodifiedKeys
Once an import edit request has been processed any keys that were not modified will be retrievable using this endpoint. It will display a list of the keys that were unmodified in the edit.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[string] Required
Unique code for the survey to which the import belongs; transmitted in the path of the request.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
instanceId=[integer] Required
Id of the import instance; transmitted in the path of the request.
pageNumber=[integer] Optional
The page number of results to be returned; each page contains 50 items; transmitted in the query.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123/unmodifiedKeys
Response Values
HTTP Code=200
200 indicates a successful response, followed by a list of the keys that were unmodified in the edit.
Sample Response
{
"1156016382",
"1156016382",
"47929431",
"1386978266",
"152974013"
}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
HTTP Status Code: 403
Occurs if the logged-in user does not have appropriate permission to access the resource.
HTTP Status Code: 404
The requested resource was not found.
Sample Call
curl -X GET "https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123/unmodifiedKeys?pageNumber=2" -H "accept: application/json" -H "api-version: 3.0"
Notes
GET validationLog
Once an import request has been processed any validation errors will be logged and retrievable using this endpoint. It displays messages for the following:
- when a field can’t be mapped to a question in the survey;
- when a value can’t find a match for an answer to a question;
- when there are multiple answers selected for a question that only supports one answer;
- basic date and number format validation.
URL
Parameters
authentication-Token=[GUID] Required
GUID that was returned from authentication; transmitted in the request header.
surveyCode=[string] Required
Unique code for the survey to which the import belongs; transmitted in the path.
instanceId=[integer] Required
Id of the import instance; transmitted in the query.
pageNumber=[integer] Optional
The page number of results to be returned; each page contains 50 items; transmitted in the query.
api-Version=[string] Optional
API version to use; transmitted in the header of the request.
Sample Request
https://dataimportapi.allegiancetech.com/api/survey/8SFFC3/imports/123/validationLog?pageNumber=1
Response Values
HTTP Code=200
PageNumber=[int]
Validation log results are presented in the form of pages; this indicates which page number the Results array is presently on.
PageSize=[int]
The number of validation log results present on the page.
nextPageUrl=[string]
The URL to get the next page of results from.
Results=[array]
Array of validation log results, composed of the following elements:
ResponseNumber=[int]
Identifier of the response that had a validation problem; this value may be zero if the response is unknown or applies to a group of responses.
FieldName=[string]
The name of the field within the response which had an error.
FieldValue=[int]
The response to the question.
ErrorDescription=[string]
Description of the error.
Sample Response
{
"pageNumber": 1,
"pageSize": 4,
"nextPageUrl": "https://example.com/survey/page_2",
"results": [
{
"responseNumber": 0,
"fieldName": "EmailAddress",
"fieldValue": "",
"errorDescription": "Unable to map EmailAddress to any survey questions"
},
{
"responseNumber": 1,
"fieldName": "Color",
"fieldValue": "Blue",
"errorDescription": "More than one response mapped for a question that only supports one answer."
},{
"responseNumber": 0,
"fieldName": "Color",
"fieldValue": "not a color",
"errorDescription": "Unable to map 'not a color' to any survey answers"
},
{
"responseNumber": 0,
"fieldName": "IntendDate",
"fieldValue": "13/13/2012",
"errorDescription": "Values of type Date were expected. Some invalid records were found."
}
]
}
Error Response
HTTP Status Code: 400
Occurs if there was an error.
HTTP Status Code: 401
Occurs if a valid authentication header wasn’t supplied.
Sample Call
curl -X GET "https://dataimportapi.dev.mcxplatform.com/api/survey/8SFFC3/imports/4545/validationlog" -H "accept: application/json" -H "api-version: 3.0"
